Python模块注释是否有约定?
我的理解是,模块docstring应该只提供模块功能的一般描述,而作者和版本等细节应该只包含在模块的注释中 但是,我在评论和文档字符串中看到了以下内容:Python模块注释是否有约定?,python,module,comments,conventions,Python,Module,Comments,Conventions,我的理解是,模块docstring应该只提供模块功能的一般描述,而作者和版本等细节应该只包含在模块的注释中 但是,我在评论和文档字符串中看到了以下内容: __author__ = "..." __version__ = "..." __date__ = "..." 放置此类物品的正确位置在哪里?其他哪些\uuuuu[name]\uuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuu
__author__ = "..."
__version__ = "..."
__date__ = "..."
放置此类物品的正确位置在哪里?其他哪些
\uuuuu[name]\uuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuu。仅当您需要在生产系统上获得这些信息时才添加它们,因为源代码已经从版本控制系统中导出。您可以查看:
- ,更具体地说,它是预定义的
它们仅仅是约定,尽管使用非常广泛。请参阅一组Python元数据要求的示例
\uuuuuuuuuuuuuuuuuuuuu版本
中提到
关于文档字符串,有一个
模块的docstring应该是
一般列出类、例外情况
和功能(以及任何其他对象)
由模块导出的,带有
每一项的一行摘要。(这些
摘要一般不太详细
而不是对象中的摘要行
docstring。)的docstring
包(即
包的init.py模块)应
同时列出模块和子包
通过包导出
但是PEP8说:如果您的源文件中必须包含Subversion、CVS或RCS crud,请按如下方式执行。version=“$Revision:84354$”#$Source$这些行应该包含在模块的docstring之后,任何其他代码之前,上面和下面用一个空行分隔。