我知道两种在python中留言的方法。一个使用"""
,另一个使用#
。我知道第一个可以用来返回一个函数帮助作为一个好处。但是,我应该什么时候使用一个,何时使用另一个?还有,我该如何评论?我是否必须按Tab键并使用下面的命令排列第一行评论?还是必须从行首开始?正确评论python命令的方式
2
A
回答
8
没有,只有one way of commenting, using #
:
注释以井字符(#)不是一个字符串的一部分,并且在物理行的结尾结束开始。
三重报价,"""
,创建一个字符串对象,这恰好被用作文档字符串时,它是一个函数,模块或一类的第一行。三重引用在其他许多地方也很有用,但不应与评论混淆。您可以像使用其他任何字符串一样使用三重引号字符串,具体优点是可以在源代码中使用实际换行符,而不必使用\n
转义字符。
虽然可以被用来通过把它变成一个多行字符串,而不是禁用的代码块,你真的应该不做到这一点。使用适当的源代码控制,并简单地删除该块,或者使用编辑器,通过替代插入#
来让您注释掉整个块。
如需实际意见,请使用#
。 Python style guide (PEP 8)有些话要说什么时候以及如何使用评论;它有这样的缩进说:
块注释通常适用于一些(或全部)后面的代码,并缩进到与该代码相同的级别。块注释的每一行都以#和单个空格开头(除非它在注释内缩进文本)。
相关问题
- 1. 如何写评论的正确方式
- 2. LESS CSS在正确的地方评论
- 3. 评论代码的正确方法。 Python的
- 4. 任何方式在Tcl命令中嵌入评论?
- 5. 灰烬模型正确的方式发表评论异步
- 6. 什么是在RavenDb中存储评论的正确方式
- 7. Magento编辑管理命令评论 - 订单 - 评论历史
- 8. 评论正则表达式
- 9. Git pull命令是mergiing命令与不需要的评论
- 10. 正确拉动edxops /论坛的方式
- 11. 通过命令删除JavaScript评论?
- 12. Disqus还没有正确地评论评论
- 13. Facebook的评论数不正确
- 14. 正确的评论扫描pyparsing
- 15. gcutil:使用命令的正确方法?
- 16. VIM自动命令的正确模式?
- 17. 什么是jsDoc评论的正确使用方法?
- 18. PHP评论,哪种方法是正确的?
- 19. 如何正确评论重写的类或方法
- 20. 如何正确评论c中的方法?
- 21. YouTube API未发布评论正确
- 22. WP评论没有发布正确
- 23. Java ProcessBuilder sudo bash命令的正确命令格式是什么?
- 24. 正则表达式匹配的评论
- 25. 正则表达式的C#评论
- 26. 以编程方式确定Python的最大命令行长度
- 27. 正确的方式不打印到外壳与发球命令
- 28. 将命令绑定到ListView项MVVM正确的方式
- 29. 以编程方式确定博客文章的评论数量
- 30. 正确使用命令模式?
http://www.python.org/dev/peps/pep-0008/#comments –