doxygenforpython:一个段落同时记录文件和包

2024-05-19 01:17:53 发布

您现在位置:Python中文网/ 问答频道 /正文

我有一个Python模块,它是一个大型项目的一部分,它有多种语言(C++、Matlab、Python等),所以我们使用DoXEGN来记录它。我用以下格式在顶部编写了一个文档字符串。在

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

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

有没有一种简单的方法可以让Doxygen把详细的文档放在这两个地方?在

这个问题在C++中也适用于^ {CD3>}和^ {CD5>}文档。在


Tags: 模块of字符串文档package列表格式记录
1条回答
网友
1楼 · 发布于 2024-05-19 01:17:53

对于任何在这里着陆的人,我已经确定以下是实现和维护这一点的最简单方法。在

##    
# \file mypackage.py
# \author me
# \brief A one-liner
# \details Lots and lots of lines of usage information
#

##
# \package mypackage
# \copydoc mypackage.py
#

相关问题 更多 >

    热门问题