python - Python 模块注释有约定吗？

Question

据我了解，模块文档字符串应该只提供模块功能的一般描述，而作者和版本等详细信息应该只包含在模块的注释中。

但是，我在评论和文档字符串中看到了以下内容:

__author__ = "..."
__version__ = "..."
__date__ = "..."

放置这些元素的正确位置在哪里？还有哪些 __[name]__ 变量通常列在模块顶部？

Answer 1

它们只是约定，尽管是相当广泛使用的约定。参见 this description一组 Python 元数据要求。

__version__ 在 Python Style Guide 中提到.

关于文档字符串，有一个 PEP just for you !

The docstring for a module should generally list the classes, exceptions and functions (and any other objects) that are exported by the module, with a one-line summary of each. (These summaries generally give less detail than the summary line in the object's docstring.) The docstring for a package (i.e., the docstring of the package's init.py module) should also list the modules and subpackages exported by the package.