Python模块中利用doc和all使help显示内部注释

向北走

发布时间：2026-10-13| 6人浏览过

原创

本文介绍如何在Python模块中通过定义文件级多行注释和__all__列表，使help()命令完整显示模块描述及函数说明。文件顶部的三引号字符串自动存入__doc__，而__all__用于控制help输出的函数列表，避免重名并优化文档呈现效果。

目的：

在使用help(模块名)命令时，能够查看到文件内部编写的注释内容。

首先，在Python源文件的最开头编写一个多行注释（即使用三引号包裹的字符串），该注释内容会被自动写入模块的__doc__变量中。当执行help查看该模块时，即可看到这段描述信息。

如果希望help输出中进一步包含具体函数的说明，则需要将这些函数名列入__all__变量中。

__all__ = ['search','fix','hello','parser']

注意__all__列表中的元素必须保持唯一，因此需要避免函数重名的情况。此外，Python本身对函数重载的支持并不充分，通常也不提倡这种做法。

配置完成后，在Python命令行环境中执行help即可查看到完整的注释信息。

例如，假设有一个名为test02.py的程序文件，先通过import导入该模块，然后执行相关查看操作。

help(test02)

或者在代码中直接调用print(help(test02))来输出帮助信息。

源代码示例如下：

#test02.py
"""
author:Zhao Zhenyu
this is an absolute test program.
"""
__all__ = ["function1", "function2"]
def function1():
pass
def function2():
"""2nd
"""
pass

实际执行结果如下：

>>> import test02
>>> help(test02)
Help on module test02:
NAME
test02
DESCRIPTION
author:Zhao Zhenyu
this is an absolute test program.
FUNCTIONS
function1()
function2()
2nd
DATA
__all__ = ['function1', 'function2']
FILE
c:\users\lenovo\documents\python scripts\python_spider\csdn例子\test02.py
>>>

以上关于Python文件内注释及help注释方法的介绍就是全部内容，希望能对大家有所帮助，也希望大家多多支持本站。