8

我正在使用 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) 是无证的。我可以用评论记录它，就像doxygen docu在将文档放在成员之后描述的那样，如果是这样，正确的方法是什么？

**编辑：**这似乎与我没有换行有关，例如这里：

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 语句与周围代码分开

4

1 回答 1

10

doxygen 目前不支持此功能，如先前在此处回答的那样。如果您将评论放在前面的行上，它将正常工作：

class escapeMode(object):
    '''
    Enum to represent the escape mode.
    '''
    ## Escape all values
    ALLWAYS     = 1
    ## Escape only values containing seperators or starting with quotation
    NECESSARY   = 2

希望这还不算太晚...

于 2012-09-26T17:44:44.770 回答