【发布时间】:2012-06-18 18:28:27
【问题描述】:
我正在使用 doxygen 并有以下代码:
def __init__(self):
'''
'''
if not '_ready' in dir(self) or not self._ready:
self._stream = sys.stderr ##!< stream to which all output is written
self._ready = True ##!< @internal Flag to check initialization of singelton
由于某种原因,doxygen 告诉我 self._stream (Member _stream) 是无证的。我可以用评论记录它吗,就像Putting documentation after members 中描述的 doxygen 文档一样,如果是这样,正确的方法是什么?
**edit:**这似乎与我没有换行有关,例如这里:
class escapeMode(object):
'''
Enum to represent the escape mode.
'''
ALWAYS = 1 ##!< Escape all values
NECESSARY = 2 ##!< Escape only values containing seperators or starting with quotation
Doxygen 只抱怨 ALWAYS 没有记录,我想避免在我记录的每个新属性后面插入换行符,因为它破坏了换行符的值,用于将循环或 if 语句与周围代码分开的逻辑块
【问题讨论】:
-
我建议一般使用Sphinx 来记录 Python 项目
-
不幸的是,目前这不是一个选项,我会看看下一个项目
-
可能是一个拼写检查工具抱怨
ALLWAYS;)