如何在py文件中提取函数的文档字符串？

问题描述

> file_name = python.py

> python.py
> def abc(x):
     """
     Hello World
     """
     pass

如您所见，python.py文件内部包含函数abc。如何在不将函数名称硬编码为help()或.__doc__的情况下从中提取文档字符串Hello World？

解决方法

您可以将pydoc用于文档字符串文档。

pydoc -w python.py

还有更多可用选项，请选择一个满足您需求的选项。

来源-https://www.python.org/dev/peps/pep-0256/

• Marc-Andre Lemburg's doc.py
• Daniel Larsson's pythondoc & gendoc
• Doug Hellmann's HappyDoc
• 劳伦斯·特拉特的水晶（在网络上不再可用）
• Ka-Ping Yee's pydoc - pydoc.py is now part of the Python standard library
• Tony Ibbs' docutils-托尼（Tony）已将此名称捐赠给Docutils项目-http://docutils.sourceforge.net/
• Edward Loper's STminus formalization and related efforts