1

Python クラスの説明に例を追加しようとしています。何らかの理由で機能しないようです。例は、生成された HTML ページの [例] タブに追加されますが、例へのリンクがクラスの説明に表示されません。特別なコマンド '@example' ( http://www.doxygen.nl/manual/commands.html#cmdexample ) をカバーする doxygen マニュアルのセクションを読みましたが、それを正しく行う方法がまだわかりません. @example コマンドをどこに配置しても、リンクが表示されないようです。私はdoxygen 1.8.5を使用しています。

例へのリンクを表示する単純化された Python クラス:

class TestClass:

    ## The constructor.
    #  @param self The object pointer.
    def __init__(self):
        self.__value = 0

    ## Stores a value.
    #  @param value The value to be stored.        
    def setValue(self, value):
        self.__value = value

    ## Gets stored value.
    #  @return The stored value.                
        def getValue(self):
        return self.__value

## @example TestClass_Example.py
#  This is an example of how to use TestClass

例は次のようになります。

from TestClass import TestClass

def main():
    myTestClass = TestClass()
    myTestClass.setValue(37)
    print "The stored value is:", myTestClass.getValue()    

if __name__ == '__main__':
    main()

どんな助けでも大歓迎です。

4

1 に答える 1

0

答えはここにあります。

つまり、doxygen の python 構文を使用して特別なコマンド (例など) を使用することはできません。で始まるコメントを使用し##、次に特別なコマンドを使用する必要があります。

この場合、doxygen の特別なコマンドはサポートされていないことに注意してください。

「##」で始まるコメントを使用して Python コードを文書化する別の方法もあります。これらのタイプのコメント ブロックは、doxygen がサポートする他の言語でドキュメント ブロックが機能する方法とより一致しており、これにより特別なコマンドを使用することもできます。

編集：ああ、ごめんなさい...あなたがすでにこれをしたことを読んでください..

doxygen がファイルへのパスを認識していることは確かですか? 同じディレクトリにありますか？EXAMPLE_PATHdoxygen設定で を設定してみてください。

于 2013-10-30T12:03:57.767 に答える