1.拡張機能をインストール
VSCodeで拡張機能ボタンをクリック
次を入力
C# XML Documentation Comments
インストールする。
2.プロジェクトを設定
.csprojに次のように追記する<GenerateDocumentationFile>true</GenerateDocumentationFile>
<DocumentationFile>Michi2.XML</DocumentationFile>
とりあえず2行目のファイルの出力先はソースフォルダ直下にしておく。
これでVSCodeでビルド時にソースフォルダにMichi2.XMLが作られている。
3.doxygenをインストール
xmlだと読みにくいのでhtml化したい、そのためにdoxygenをインストールする。
http://www.doxygen.jp/
linux版のバイナリをダウンロードしてローカルに展開。
/opt/doxygenなど適当にフォルダを掘ってコピーする。
パスを通しておく。
4.doxygenを実行
Michi2.XMLのフォルダに移動し実行する。
$ doxygen Michi2.XML
2つのフォルダhtml、latexが作られている。
フォルダhtml内のindex.htmlを開くとできている。
LaTeX形式の出力もできるのね、懐かしい。
とりあえずドキュメントの生成はできました。
5.補足とか、次のステップとか
doxygenの実行時に色々オプションを指定してやればよい。
面倒ならdoxywizardを実行してGUIでやってもいいかも。お好みで。