Question

我正在使用doxygen记录一个python项目。我创建了我的配置文件，并设置了In和out Directory，但这就是我真正做的。当我生成文档时，它会提取类和类层次结构，但对于具有函数的模块，它不会。

同样，我有一个.py文件，它有一个main函数和一组函数，我已用正确的注释语法记录，但这些函数没有在文档中表示。这是为什么？

Answer 1

使用默认的doxygen配置时，只有在记录它们所在的文件或模块时才会记录模块级功能。例如：

##
# My function
#
def func():
    pass

除非记录文件，否则不会记录：

##
# @file
# File documentation
#

或者记录模块：

##
# @package MyModule Module documentation
#

有关在Doxygen中记录Python代码的更多信息，请参阅http://www.doxygen.nl/manual/docblocks.html#pythonblocks。

Answer 2

与官方文档相反，文档字符串中支持“特殊命令”。为此，文档字符串必须以““”开头！

示例：

def area(l, w):
    """! Calculate the area in sqm

    @param l length 
    @param w width
    @return area 

    @todo throw error if l<0 or w<0
    """
    return l*w

2 个答案: