Re: ソースコードのドキュメント

人物: AndrewBuck

問題ない。だからこそドキュメントを書き始める前に確認した。それでもドキュメント化したいし、受け入れられるシステムを見つけられるかもしれない。一つの方法は、自分のコードに対して Doxygen を実行し、説明などを追加せずに自動生成されたドキュメントだけを使うことだ。これならプロジェクトに影響はないが、ドキュメントの有用性は制限される。

2 つ目の、おそらくより魅力的な方法は、Doxygen がドキュメントしているソースコードと同じファイルに追加ドキュメントを含める必要がないという事実を利用することだ。関数名へのリンクを持つドキュメントブロックを含む単一のファイルを追加できる。Doxygen はこれをソースから収集した自動生成情報と組み合わせてドキュメントを生成する。

最後に、Doxygen を使うかどうかに関係なく、プログラムのコマンドラインオプションを文書化する「man ページ」を書きたい。コマンドラインはコードのどこで処理されているだろうか? main.cpp を見たが見つからなかった(実際、“main”関数すら見つからなかった)。

-Buck