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 に答える