带有“#”或“#:”的 Python 注释 [关闭]

Posted

技术标签:

【中文标题】带有“#”或“#:”的 Python 注释 [关闭]【英文标题】:Python comment with "#" or "#:" [closed] 【发布时间】:2016-09-18 00:57:36 【问题描述】:

在 Python 中编写 cmets 时,##: 有什么区别?

【问题讨论】:

'#' 和 '#:' 的区别是一个 ':'。有什么问题? 没有区别 您链接的代码中没有出现#:。是什么让你觉得#: 有什么特别之处? Python 的注释只有 #。之后的任何内容都是注释代码。 : 是该评论的一部分。至于为什么有人会在评论开头加上:,你应该问他们。 @user2357112 第 294 行 【参考方案1】:

Flask 使用Sphinx 生成文档,并使用Sphinx uses #: 标记记录属性的 cmets:

对于模块数据成员和类属性,文档可以放在具有特殊格式的注释中(使用#: 来开始注释,而不仅仅是#),或者放在文档字符串之后 em> 定义。

另外,来自 Flask 的style guide:

如果注释用于记录属性,请在开始的井号后加一个冒号 (#)

如果您没有使用像 Sphinx 这样能够理解 #: 的文档生成器,那么使用 #: cmets 毫无意义。特别是,Python 不会将它们与任何其他 cmets 区别对待。

【讨论】:

感谢您对新手的耐心等待。这正是我想知道的。【参考方案2】:

“#”之后的所有内容都是注释,只是口味问题。 你可以用小写,大写,驼峰写,只要你明白你在评论什么。

如果你真的想评论一些东西,你可以使用类似的东西:

#####################
###### TITLE ########
#####################
print 'hello world'

【讨论】:

以上是关于带有“#”或“#:”的 Python 注释 [关闭]的主要内容,如果未能解决你的问题,请参考以下文章

带有接口和实现类的 XML 文档注释 [关闭]

带有方法的 Python 类 [关闭]

关闭“Python 3.5 版不支持变量注释”错误消息

Python:QMainWindow 对话框关闭后如何关闭(或退出)Python 进程

Python Pandas - 读取带有注释标题行的 csv

python 用于Python 3的简单Web服务器,带有针对单行Web服务的注释说明。