DoxygenをWindowsパソコンにインストールする方法について紹介します。
【Doxygenとは】概要とメリット
Doxygen(http://www.doxygen.jp/) とは、専用の記法でコメントを書くことで、自動でドキュメントを作成することができ、GNU General Public Licenseで配布されています。
– | メリット |
---|---|
1 | 多くのファイル形式(HTML、LATEX、Wordなど)でドキュメントを出力できる。 |
2 | 多くの言語に対応している(C++,C,Java,Objective-C,Python,IDL (Corba,Microsoft風),Fortran,VHDL,PHP,C#など)。Pythonには専用のPydocがあるが、Doxygenの記法ならマルチで使用できる。 |
2 | ソースコードを解析するので一貫性が保たれる。 |
3 | 内包・依存図,継承図,およびコラボレーション図により視覚化することができる。 |
4 | 昔からあり、ユーザーも比較的多いため、今後も継続的に利用できる可能性が高い。 |
【使用例】テンプレート
個人的に最低限これくらいの項目を書いておけばいいんじゃないかなと思うものを載せてみた
@exampleや@code~@endcodeを用いて使用例を載せるとより良いドキュメントになると思う
【Python超入門】使い方とサンプル集
Pythonとは、統計処理や機械学習、ディープラーニングといった数値計算分野を中心に幅広い用途で利用されている人気なプログラミング言語です。 主な特徴として「効率のよい、短くて読みやすいコードを書きやすい」、「ライブラリが豊富なのでサクッと...
コメント