DoxyPy - 命名空间的成员（变量）未记录

Question

我收到有关 doxygen (doxypy) 文档的错误消息 warning: Member constant1 (variable) of namespace <file_name> is not documented.。我已经记录了文件和所有函数和类。但是我在这个文件中还有一些额外的常量，我不知道如何记录它们并且我收到了错误消息。该文件如下所示：

"""\file
\brief <this is what the file contains>
\author <author>
"""

import numpy as np

constant1 = 24
constant2 = 48

def someFunction():
    """ Doxygen documentation of someFunction() """
    <body>

在此示例中，我如何记录 constant1 和 constant2，以便错误消息消失？

Answer 1

@albert 是对的。当在变量前放置 ## 时，它会起作用。我没有找到使用 """ 语法的解决方案。

"""\file
\brief <this is what the file contains>
\author <author>
"""

import numpy as np

## Doxygen documentation for constant1
constant1 = 24

## Doxygen documentation for constant2
constant2 = 48

def someFunction():
    """ Doxygen documentation of someFunction() """
    <body>

Answer 2

如果您（出于任何原因）需要为这些成员提供更多文档，您也可以将文本分成几行。它将被视为 """ 块。

## Doxygen documentation for constant1. The way which you already found.
constant1 = 24
## Doxygen documentation for constant2.
#  If you need to write a lot about constant2, you can split the text into
#  several lines in this way.
constant2 = 48

DoxyPy - 命名空间的成员（变量）未记录

DoxyPy - Member (variable) of namespace is not documented

python

doxygen