DoxyPy-名称空间的成员(变量)未记录 [英] DoxyPy - Member (variable) of namespace is not documented
问题描述
我收到错误消息 warning:名称空间< file_name>的成员常量1(变量).没有记录.有关我的doxygen(doxypy)文档.我已经记录了文件以及所有函数和类.但是我在此文件中还有一些其他常量，这些常量我不知道如何记录，并且收到错误消息.该文件如下所示:
I get the error message warning: Member constant1 (variable) of namespace <file_name> is not documented. for my doxygen (doxypy) documentation. I have documented the file and all functions and classes. But I also have some additional constants in this file which I don't know how to document and I get the error message. The file looks like this:
"""\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 ，以使错误消息消失?
In this example, how do I document constant1 andconstant2, so that the error message goes away?
推荐答案
@albert是正确的.将 ## 放在变量前面时，它可以工作.我没有找到使用""语法的解决方案.
@albert was right. It works when putting a ## in front of the variables. I didn't find a solution using the """ syntax.
"""\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>
这篇关于DoxyPy-名称空间的成员(变量)未记录的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！
