DoxyGen編
ホーム < ゲームつくろー！ Doxygen編 ゲームを製作する時に、見落としがちになってしまうのが「ドキュメント化」です。自分が作成したライブラリにある程度のドキュメントをつけておかないと、2ヵ月後にはすっかり他人コードに化けてしまって中身を忘れます。そういう時にドキュメントがあると思い返すきっかけとなり、またライブラリの寿命も延びます。 本編で取り上げるDoxygenはドキュメント自動生成ツールの一つです。コードに埋め込まれた特殊なドキュメントを読み込んで、HTML形式などのドキュメントを生成してくれます。 コードのドキュメント化は悩ましい問題です。例えばテキストファイルやWordなどでドキュメントを作ったとしましょう。この場合、書式を揃えるのがまずは大変です。クラス名はスペース2つ、メソッド名は4つ入れて引数は…。これを作成したすべてのクラスで行う事を想像すると怖いです。またせっかく
その３ ヘッダーファイルにDoxygenコメントを追加する
ホーム < ゲームつくろー！ < Doxygen編 その３ ヘッダーファイルにDoxygenコメントを追加する Doxygenはコードにある特殊なコメントを解読してマニュアルに追加していきます。このコメントを書く作業はプログラマが行いますが、それが同時にマニュアル作成になっているわけです。この章ではヘッダーファイルに書くコメントを見ていく事にしましょう。 ① 各種コメント テストとして次のようなコードにDoxygenコメントをつけて行きます： class MyClass { public: MyClass(); virtual~ MyClass(); int get(); bool set( int value ); protected: void clamp( int value ); protected: int m_value; }; このまっさらな段階でDoxygenを通すとこちら
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
freeml（フリーエムエル）｜新しい生活をはじめる羅針盤
