タグ

doxygenに関するhorihorioのブックマーク (2)

  • doxygenで、各種形式のドキュメントを作ってしまおう - ふにゃるんv2

    世の中のプログラマは、基的にものぐさだ。 (あ〜、言っておくが、カット&コピーしまくるのは、ものぐさとは言わない。ありゃ、ロボットだと思う) コード作りには熱心になれても、ドキュメント作成になると一気に能率が落ちるのが常だ。 てな訳で、ソースコードからドキュメントを自動生成しようとする人達が現れる。自分の狭い知識では、 C/C++だと、doxygen Javaだと、JavaDoc Pythonだと、pydoc あたりが有名みたいだ。 で、題名にあるpythonで、(pydocがあるのに)何故わざわざdoxygenを使うのかって言うと、引数とか返値などを明示する書き方とか、それをドキュメント化する手段がないかな?と探した結果が コレ という訳。後、doxygenだと後で述べるように、様々な形式のドキュメントファイルを一気に出力できる所があるので。 引数とか返値とか何で細かく書きたいのか?っ

    doxygenで、各種形式のドキュメントを作ってしまおう - ふにゃるんv2
  • ソースコードからドキュメントをDoxygenで生成する

    新トップページへ | Tip ソースコードからドキュメントをDoxygenで生成する LastUpdate : 13/01/02 JavaDoc的なことをC++でもやろう、という話です。 正直、JavaDocで生成したHTMLを見て役に立ったことがあまり有りませんが、コメントを書く際の統一的な書式としては役に立つと思います。 もくじ はじめに Doxygenのインストール コメントの書式 ドキュメントを生成する はじめに 詳細はこちら(http://www.doxygen.jp/)を参照。 日語サイトがあるので、非常に便利です(すごい!)。また、非常に多機能。 実際、使えるようなドキュメントにするかしないかはコメントを書く人次第だが・・・。 このページでは、コメントの基的な書き方をサンプルとしてあげる程度に留める。 また、Doxygenは、コメントの書式がいくつかのタイプから選べるが(

  • 1