在python中正确评论命令的方法

时间:2013-06-23 15:31:28

标签: python comments

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

1 个答案:

答案 0 :(得分:8)

不,只有one way of commenting, using #

  

注释以不属于字符串文字的哈希字符(#)开头,并以物理行的末尾结束。

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

虽然可以用于通过将代码块转换为多行字符串来禁用代码块,但您确实应该执行此操作。使用正确的源代码控制并简单地删除该块,或者使用一个编辑器,通过为您插入#来注释整个块。

要获得实际评论,请使用#Python style guide (PEP 8)对何时以及如何使用评论有一些说法;它有关于缩进的说法:

  

块注释通常适用于跟随它们的一些(或所有)代码,并缩进到与该代码相同的级别。块注释的每一行都以#和单个空格开头(除非它是注释中的缩进文本)。