使用python的Doxygen不提取文件的方法描述

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

---

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

对于默认的doxygen配置，只有当模块级功能所在的文件或模块也被记录时，才会记录模块级功能。例如：

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

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

##
# @file
# File documentation
#

##
# @package MyModule Module documentation
#

或者将模块记录为：

##
# @file
# File documentation
#

##
# @package MyModule Module documentation
#

---

有关在Doxygen中记录Python代码的更多信息，请参阅。

对于默认的Doxygen配置，只有在记录了模块级函数所在的文件或模块时，才会记录模块级函数。例如：

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

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

##
# @file
# File documentation
#

##
# @package MyModule Module documentation
#

或者将模块记录为：

##
# @file
# File documentation
#

##
# @package MyModule Module documentation
#

---

有关在Doxygen中记录Python代码的更多信息，请参阅。

与官方文档不同，docstring中支持“特殊命令”。为此，docstring必须以“”开头

例如：

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

def区域（左、西）：
"""! 以平方米为单位计算面积
@参数l长度
@参数w宽度
@返回区
@如果与官方文档相反，DocString中支持“特殊命令”，则todo抛出错误。为此，docstring必须以“”开头

例如：

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

def区域（左、西）：
"""! 以平方米为单位计算面积
@参数l长度
@参数w宽度
@返回区
@如果l#如果EXTRACT#u ALL标记设置为YES，则todo抛出错误doxygen将假定#文档中的所有实体都已记录，即使没有可用文档私有类成员和静态文件成员将隐藏，除非#EXTRACT_Private和EXTRACT_static标记设置为YES EXTRACT_ALL=YES#如果EXTRACT_Private标记设置为YES，则类的所有私有成员都将包含在文档中。EXTRACT_PRIVATE=yes将“否”更改为“是”。问题解决了。。。不知道如何结束此问题。Colton，将您的解决方案作为答案发布，然后接受它。#如果EXTRACT_ALL标记设置为YES，doxygen将假定#文档中的所有实体都有文档，即使没有可用文档。#私有类成员和静态文件成员将隐藏，除非#EXTRACT_Private和EXTRACT_static标记设置为YES EXTRACT_ALL=YES#如果EXTRACT_Private标记设置为YES，则类的所有私有成员都将包含在文档中。EXTRACT_PRIVATE=yes将“否”更改为“是”。问题解决了。。。不知道如何结束此问题。Colton，将您的解决方案作为答案发布，然后接受它。还要注意，您不能使用Pythons
“
”记录文件/模块，因为Doxygen不支持这些注释中的特殊命令。还要注意，您不能使用Pythons
“
”记录文件/模块，因为Doxygen不支持这些注释中的特殊命令。