Doxygen!!

     いやぁ~、気がつけばもう6月も半ば(;´∀`) 梅雨が来そうで来ない、暑そうで暑くない、そんなモヤモヤした日々が続きますが皆様如何お過ごしでしょうか。
     このブログもすっかり放置されてたんですが、そろそろ何か書かないとFC2からの見えない・・・いや、メッチャ全力の書けやゴラァ圧力がかかってるんで、いい加減更新します。

     今回はプログラムのドキュメントを書くのが死ぬほど面倒な人々に送る、素敵なドキュメント作成補助ツール
    Doxygen
    です。
     これはなんと、プロジェクトのルートディレクトリを指定すればそれっぽくクラスリファレンスやらなんやらを自動作成してくれるとっても素晴らしいツールらしいのです!!
     ワイはこんなんをずっと待っとったんやぁ~!(∩´∀`)∩ワショーイ

     日本語の解説書まであるので、ありがたく使わせて頂きましょ~☆
        http://www.doxygen.jp/


     このツールは任意の書式で書かれたプログラムコードを解析して、クラスリファレンスや関数リファレンスを作成してくれます。
     因みにボクはメインはPythonなんで、ここではPythonについて簡単に説明します。
     Pythonはもともとコメントが書式化されており、任意の方法で記述すると__doc__に保存されるようになっているので、普段からコメントに気をつけている方はそれほど気にしないくても大丈夫なようです。
     ただし、Doxygen用のフォーマットにすると、より見やすいヘルプが出来上がるようです。
        Python での特殊ドキュメント・ブロック

     また、Pythonの出力をする場合はModeをOptimize for Java or C# outputにせよとマニュアルに書いてますね。
     for Pythonはないようで・・・

     と、今日はざっくりと紹介まで。
     これでソースコードをマニュアル代わりに・・・と言う残念な現状から脱却できるかぁっ!?
    スポンサーサイト

    コメントの投稿

    非公開コメント

    プロフィール

    Eske

    Author:Eske
    萌えイラストレーターを目指す3DCGイラストレーター。
    現在ポケモンカードゲーム、ガンダムトライエイジ、ガンダムコンクエスト、妖怪ウォッチとりつきカードゲームなどで3DCGを使用したイラストレーターとして参加中。

    主にここでは日々気づいたメモなんかを残してます。
    イラストのお仕事も受け付けております。ココのメールアドレスからご連絡できますので、お気軽にご相談下さい。

    最新記事
    最新コメント
    カテゴリ
    最新トラックバック
    月別アーカイブ
    検索フォーム
    リンク
    QRコード
    QR