ドキュメント作成ツール

よく分からないけど、doxygen, NDoc, SandcastleGUI, Atomineer Utils add-in for VS 2005/2008/2010を入れてみた

doxygenについて

Doxygen
http://www.doxygen.jp/
ecloxとdoxygenで仕様書メンテナンスの効率をUP!(1/4) − @IT MONOist
http://monoist.atmarkit.co.jp/fembedded/articles/eclipseccplusplus/04/eclipseccplusplus04a.html
どうやらdoxygenは独自のコメント記法を使うらしい


doxygenマニュアル日本語訳
http://www.fides.dti.ne.jp/~oka-t/doxygen-manual/html/



コード構造を視覚化せよ!!(Graphviz & Doxygen
http://skazami.web.infoseek.co.jp/tools/Graphviz_Doxygen.htm


doxygenだとgraphvizという図示ツールと連携できるっぽい。


Graphviz
http://www.graphviz.org/


Visual Studioからdoxygenを実行するためのプロジェクトファイルが同梱されてるらしい


Visual Studio with DoxyGen for documentation, or should we use something else? - Stack Overflow
http://stackoverflow.com/questions/2028264/visual-studio-with-doxygen-for-documentation-or-should-we-use-something-else


doxycommentというツールもあるらしいがC#では使えないらしい


NDoc

Visual StudioではNDocで使うコメント記法で補完されるので、
どうやらVisual StudioとはNDocのほうが相性いいらしい


C# Tips −XMLドキュメントとNDoc−
http://www.divakk.co.jp/aoyagi/csharp_tips_ndoc.html

1. まず「ファイル」−「プロジェクトの追加」−「新しいプロジェクト」で「Visual C++プロジェクト」−「メイクファイルプロジェクト」を新規作成します。プロジェクト名は「Document」とかでいいでしょう。ディレクトリとかは適当に。
2. プロジェクトの新規作成時に出てくる「メイクファイル アプリケーション ウィザード」は全部デフォルトのまま「完了」で構いません。
3. そうするとソリューションエクスプローラに「Document」が追加されるはずですから、その「Document」を右クリックして「プロパティ」を開いてください。
4. プロパティのダイアログで「NMake」を選択して、「ビルド コマンドライン」に "NDocConsole.exe -project=test.ndoc" のようにNDocConsole.exeを起動するコマンドを入れてください。
5. ソリューションエクスプローラの「Document」の下にある「ソースファイル」「ヘッダーファイル」「リソースファイル」は邪魔であれば削除してしまっても構いません(もちろん、あっても構いません)。

こうしておけば、ビルドするたびにドキュメントも生成されます。

NDOC日本語版 Project Top Page - SourceForge.JP
http://sourceforge.jp/projects/ndoc-jp/


これは便利そう。でも、.NET Framework2.0以降には対応してない。
次のページに強引に対応させる方法が書かれている。


failuresoft.com :: NDoc 1.3.1 - .NET 2.0 対応
http://www.failuresoft.com/report/ndoc/ndoc13_dotnet20
自作したクラスライブラリのヘルプ(ドキュメント)を作成する: .NET Tips: C#, VB.NET, Visual Studio
http://dobon.net/vb/dotnet/vs/commentwebreport.html

Sandcastle

Download details: Sandcastle - Version 2.4.10520
http://www.microsoft.com/downloads/details.aspx?FamilyId=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en
microsoft謹製。


Sandcastle Help File Builder
http://www.codeplex.com/SHFB
GUI版。


Sandcastle Help File Builder を使って、ソースコードからドキュメントを自動作成しよう - ふにゃるん
http://d.hatena.ne.jp/Wacky/20070108/1168237297
よくまとまった記事。


【ハウツー】SandcastleXMLドキュメントコメントからヘルプを生成する - HTML生成編 (1) XMLドキュメントコメントの書き方 | エンタープライズ | マイコミジャーナル
http://journal.mycom.co.jp/articles/2008/07/15/Sandcastle/index.html



その他

Atomineer Utils add-in for VS 2005/2008/2010
http://visualstudiogallery.msdn.microsoft.com/ja-jp/7912CCF4-60B8-4132-BACE-5ACACEB7233B
アドインというのがまだ分かってないが、DocXml形式のドキュメントコメントが作れるらしい
AtomineerUtils for VisualStudio (VS 2005, VS 2008, VS 2010)
http://www.atomineerutils.com/products.php

The documentation comments are compatible with the following systems:

* Documentation XML (DocXml) format as supported by Visual Studio, Intellisense, and the SandCastle documentation builder.
* Doxygen and JavaDoc formats.
* Humans! AtomineerUtils provides a number of automatic formatting, word wrap and punctuation facilities to make comments tidy and readable for humans too.

インストール仕方
http://www.atomineerutils.com/userguide.php