python - python 成员之后的文档(使用 doxygen)

Question

我正在使用 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 在 Putting documentation after members 中描述的那样如果是这样，正确的方法是什么？

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

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 没有记录，我想避免在我用这种方式记录的每个新属性后面插入换行符，因为它破坏了换行符的值(value)，用于分隔逻辑 block ，如循环或 if 语句周边代码

Answer 1

这在 doxygen 中目前不受支持，如前所述 here . 如果您将注释放在前一行，它将正常工作:

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

希望还不算太晚......