我正在使用 python 3.1。
是否可以为单个模块或函数创建超过 1 个文档字符串?我正在创建一个程序,并且打算拥有多个文档字符串,每个文档字符串都有一个类别。我打算向其他人提供该程序,以便他们可以使用它,并且为了让程序员和非程序员都轻松使用它,我在程序本身中放置了对文档字符串的引用。
更具体地说,我在程序/模块中有一个菜单作为界面,其中一个选项将允许访问模块文档字符串以获取程序文档。因此,如果可能的话,我想制作多个文档字符串来对不同类型的文档进行分类。因此,如果用户想查看文档的某些部分,会更容易。
例如。第一个文档字符串包含有关如何使用该程序的说明。第二个文档字符串包含有关程序的一部分如何工作的信息。第三个文档字符串包含有关其他部分如何工作的信息。ETC。
这可能吗?如果是这样,你如何引用它们?
更新:添加了评论。
我最初的想法是实际上拥有多个文档字符串,其含义如下:
def foo():
"""docstring1: blah blah blah"""
"""docstring2: blah blah blah"""
pass # Insert code here
Run Code Online (Sandbox Code Playgroud)
然后我可以使用一些代码来引用每个文档字符串。那么,我猜这是不可能的?