[py]pydocはHTMLに出せばUTF-8日本語も見える

使い方が面倒なpythonライブラリを作っていたので、後から思い出せないだろうと思い、コメントを書いている。
ライブラリを作っているというよりは、コードを書いて、ここは他でも使えるかも、と思ったら関数化しているだけなので、かなり行き当たりばったりだ。

 

こんな感じのソースを作っている。

#!/usr/bin/env python
# -*- coding: utf-8 -*- 
"""
test library
"""
##
# @file    test.py
# @brief   test 
library
##
# テストデータ
TEST_VALUE = '\x12'

##
# テスト関数
# @param[in]        msg         メッセージ(str)
# 
@return           bytearray値
def testfunc(msg):
    # 
テスト関数
    return msg.decode('hex')

 

これを、cygwinのpydocに通すと、こうだ。

しかし、-wオプションを付けてHTML出力すると、こう。

コンソールでちょっと確認する、という用途には使えないのだが、まあ、これはこれでよいかな、と思う。
doxygenコメントを入れているので、pydocでもフォーマットはされていないながらなんとなく引数の説明もできているし。

 

doxygenに通すと、こんな感じだ。

悪くないんじゃないかね。