2016/10/25

[py]pydocとdoxygenの両立がうまくいかない

自分用にユーティリティ関数を作っていたのだけど、どうせしばらくすると忘れてしまうだろうからコメントを付けておこうと思う。

どうせコメントを付けるなら、いつものようにdoxygen形式にするか、と思ったのだが、どうもpythonにはpydocというしくみがあるようだ。
これもまたコメントにしたものをドキュメントにするツールなのだが、特殊な構文はないようで、それっぽい位置にコメントを書いておけばドキュメントになってくれるようだ。

 

それでもよいかと思っていたのだが、変数にドキュメントとしてのコメント付けができないらしく、定数がいくつかあるモジュールだったので、ちょっと寂しい。
まあ、pythonは定数というものがないようなので、安全に運用するなら関数化して置いた方が無難なのだろうが、練習だ。


#encoding:utf-8

## @file    doxy.py
## @brief   doxygenで書いてみよう


## すごい関数
# @param[in]    prm1    すごい引数
# @return       すごい結果
def func1(prm1):
    '''
    good function
    '''
    return prm1 + 'is very good !!'

こういうpythonファイルを書いておくと、pydocでこう見える。

Help on module doxy:

NAME
    doxy - #encoding:utf-8

FILE /cygdrive/d/Prog/python/study/doxy.py

FUNCTIONS
    func1(prm1)
        good function

 

これはまだよいのだが、doxygen出力の方だ。

image

関数内のコメントが映り込んでしまった。
なんか、技はないものか。。。

0 件のコメント:

コメントを投稿

コメントありがとうございます。
スパムかもしれない、と私が思ったら、
申し訳ないですが勝手に削除することもあります。