2013-06-23 44 views
2

我知道两种在python中留言的方法。一个使用""",另一个使用#。我知道第一个可以用来返回一个函数帮助作为一个好处。但是,我应该什么时候使用一个,何时使用另一个?还有,我该如何评论?我是否必须按Tab键并使用下面的命令排列第一行评论?还是必须从行首开始?正确评论python命令的方式

+2

http://www.python.org/dev/peps/pep-0008/#comments –

回答

8

没有,只有one way of commenting, using #

注释以井字符(#)不是一个字符串的一部分,并且在物理行的结尾结束开始。

三重报价,""",创建一个字符串对象,这恰好被用作文档字符串时,它是一个函数,模块或一类的第一行。三重引用在其他许多地方也很有用,但不应与评论混淆。您可以像使用其他任何字符串一样使用三重引号字符串,具体优点是可以在源代码中使用实际换行符,而不必使用\n转义字符。

虽然可以被用来通过把它变成一个多行字符串,而不是禁用的代码块,你真的应该做到这一点。使用适当的源代码控制,并简单地删除该块,或者使用编辑器,通过替代插入#来让您注释掉整个块。

如需实际意见,请使用#Python style guide (PEP 8)有些话要说什么时候以及如何使用评论;它有这样的缩进说:

块注释通常适用于一些(或全部)后面的代码,并缩进到与该代码相同的级别。块注释的每一行都以#和单个空格开头(除非它在注释内缩进文本)。