web-dev-qa-db-ja.com

GhostDocタイプのツールの代替ツール

関数またはイベントハンドラー（ GhostDoc など、適切なツールではないと思われる）を指定すると、コードの説明（コメント）を生成する.NET用のツールはありますか？

c#.netvisual-studio-2005
17
peter

VS2010で///を使用してコメントを開始すると、コメントしている関数に基づいてXMLで基本的なパラメーターが作成されます。

http://msdn.Microsoft.com/en-us/magazine/dd722812.aspx

したがって、関数startMonitor(ManagementScope scope)の前に///と入力すると...

/// <summary>
/// 
/// </summary>
/// <param name="scope"></param>
static void startMonitor(ManagementScope scope)

これらから適切なドキュメントを生成したい場合は、最初に立ち寄る場所として https://github.com/EWSoftware/SHFB をお勧めします。かなりエースです。

13
dotalchemy

実際、///はドキュメントを生成せず、空のXMLタグのみを生成します。 GhostDocが優れているのは、プロパティ、クラス、可視性、使用法などのコンテキスト情報に基づいて、MSDNスタイルのドキュメント（詳細を含む）を自動的に生成することです。

ここにいくつかの真の選択肢があります：

  • Atomineer （GhostDocより少し安い）
  • Resharper（プロジェクトでXMLコメントを有効にした場合にのみ機能しますが、上記の2つほど優れていません。基本クラス/インターフェイスからXMLコメントをコピーすることもできます）。

さて、あなたが何をするにしても、非文書化を生成しないでください！ :)

18
Mrchief

サンドキャッスル を見てください。 Visual Studio2005プロジェクトで動作します。 nDoc でまだ利用可能なダウンロードもあります。 2005年頃に全盛期を迎えましたが、それ以来、開発はほとんど、あるいはまったく行われていないと思います。

実際にコードコメントを事前入力するものを探している場合、GhostDocよりもはるかに優れた方法があるかどうかはわかりません。

2
Paul Sasik