Python中的惯用文件级注释是什么？

Question

3

当我需要写关于函数的详细注释时，我使用文档字符串。但是，我不确定Python中文件级别注释的等效方式是什么，以及模块和脚本是否有所不同。

这种风格常用吗？

"""
file.py: module for X
Detailed information...
"""

import x

def foo(bar):
  return 42

或者是这个？

# file.py: module for X
# More info...

import x
# ...

有什么想法吗？

- Oliver

2

始终使用第一个选项，因为它实际上会填充__doc__，而另一个只是一条注释。 - undefined

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- MaxNoe · Accepted Answer

始终使用字符串，因为这将实际填充当前文件/模块的__doc__变量。

与此相比：

'''Hello World'''
print(__doc__)

to

# Hello World
print(__doc__)

考虑在模块foo.py中执行以下代码，将输出与给出的结果进行比较：

>>> import foo
>>> help(foo)

你不需要添加“file:...”部分，因为Python会自动显示它。