Python的氧:一个段落记录文件和包

Doxygen for Python: one paragraph to document both file and package

本文关键字：记录 段落 文件 一个 的氧 Python      更新时间：2023-10-16

我有一个Python模块，它是一个更大的项目的一部分，包含多种语言(c++， Matlab, Python等)，所以我们使用氧气来记录它。我在顶部写了一个文档字符串，格式如下:

##
# package mypackage
# author me
# brief A one-liner
# details Lots and lots of lines of usage information
#

正确显示生成文档的Class List和Package List中的所有内容。然而，当我在文件列表中单击mypackage.py时，我什么也得不到。我可以通过将上面的package替换为file来显示它，但是然后类列表和包列表没有任何详细的文档。

是否有一种简单的方法可以让氧把详细的文档放在两个地方?

这个问题也适用于c++中的file和class文档。

对于在这里着陆的任何人，我已经确定了以下最简单的方法来实现和维护它。

##    
# file
# author me
# brief A one-liner
# details Lots and lots of lines of usage information
#
##
# package mypackage
# copydoc mypackage.py
#
相关文章：