python文档字符串_在python模块中放什么文档字符串？

如果你有x.py："""This module does blah blah."""

class Blah(object):

"""This class does blah blah."""

然后：>>> import x; help(x)

显示：Help on module x:

NAME

x - This module does blah blah.

FILE

/tmp/x.py

CLASSES

__builtin__.object

Blah

class Blah(__builtin__.object)

| This class does blah blah.

|

| Data and other attributes defined here:

|

| __dict__ =

| dictionary for instance variables (if defined)

|

| __weakref__ =

| list of weak references to the object (if defined)

关于类的详细信息（以及函数，尽管我没有在这里展示）已经包含在这些组件的文档中; 模块自己的文档字符串应该非常概括地描述它们，而是集中精力总结一下模块作为一个整体可以为你做什么，理想情况下用一些文档化的例子（就像函数和类最理想的应该在theit docstrings）。

我没有看到作者姓名和版权/许可证等元数据如何帮助模块的用户 - 它可以进行评论，因为它可以帮助有人考虑是否重用或修改模块。