python中成员后面的文档(使用doxygen)

2024-04-25 19:14:36 发布

您现在位置:Python中文网/ 问答频道 /正文

我使用的是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._streamMember _stream)是未记录的。我可以用注释来记录它吗,就像doxygendocu在Putting documentation after members中描述的那样,如果是,正确的方法是什么?在

**编辑:**这似乎与我没有新行有关,例如:

^{pr2}$

Doxygen只抱怨ALWAYS没有文档化,我希望避免在我文档中的每个新属性后面插入新行,因为这样会破坏新行的值,从而将逻辑块(如循环或if语句)与周围代码分隔开


Tags: orto代码in文档selfstreamif
1条回答
网友
1楼 · 发布于 2024-04-25 19:14:36

正如前面的回答here,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

希望不要太晚。。。在

相关问题 更多 >