2009-07-02 8 views
0

私の最初のC#クラスを完成させています。継承した元のコードは完全にコメントではありませんが、私がJavaを書いていて、コードが現在それらのブロックなしで奇妙に見えるときのメソッド。コメントスタイル(Javadocing C#バージョン) - (Java Developer C#)

私は通常、Eclipseで "Insert JavaDoc"コマンドを使用してコメントをフォーマットしました。このコマンドは、テンプレートをレイアウトし、コマンドが実行されたメソッドからパラメータ、メソッド名などを取得するだけです。その後、そこから詳細を追加することができました。

Visual Studio 2008にも同様のコマンドがありますか?私はメニューの周りを突っ込んでいたときに私は見つけられませんでした。さらに、C#の世界で使用されている(JavaDocに似た)スタイルをコメントする標準的な規則がありますか?

答えて

6

///と入力すると、IDEエディタによって自動的に空のXMLコメントが生成されます。あなたの方法は、あなたが.NETが宣言した例外を持っていないので、手動でタグを追加する必要があります任意の例外をスローする場合

/// <summary> 
/// 
/// </summary> 
/// <param name="qName"></param> 
/// <param name="contextNode"></param> 
public QName(String qName, XmlNode contextNode) { 

この:

/// 
public QName(String qName, XmlNode contextNode) { 

が、このなります。最終コメント:

/// <summary>Creates a new QName from a string with the format 
/// <c>prefix:local-name</c> or <c>local-name</c>.</summary> 
/// 
/// <param name="qName">A QName string.</param> 
/// <param name="contextNode">An XML node from which to lookup the namespace 
/// prefix, or <c>null</c>.</param> 
/// 
/// <exception cref="XmlInvalidPrefixException">Thrown if the prefix cannot be 
/// resolved from the lookup node. If <paramref name="contextNode"/> is 
/// <c>null</c>, then the only prefix that can be resolved is <c>xml</c>. 
/// </exception> 
public QName(String qName, XmlNode contextNode) { 
1

タイプ3の順方向は、任意の方法の前にスラッシュ:

/// 

これは、XMLコメントブロックを生成します。

1

Visual Studioでメソッドの前にスラッシュ「///」を3つ入力すると、メソッドをコメントするためのシンプルなテンプレートが自動的に作成されます。 (パラメータと戻り値についてもコメントをつけるフィールドが作成されます)。これは素早く簡単だからいいと思いますが、もっと深いものが必要な場合があります。

1

C#では、コメントの上に3つのスラッシュを入力すると、自動的にターゲットの適切なテキストが挿入されます。

それはあなたがその後、それらのコメントを取り、そこからAPIドキュメントを構築するためにNDocのようなものを使用することができる等の概要、パラメータ(もしあれば)、リターン(もしあれば)、

/// 

が含まれます。

1

無料アドインのVisual Studioのため、GhostDoc、あなたは///は、Visual Studio自体からあなたを取得するより少しを提供し、C#のXMLドキュメントの基本構造を作成するのに役立ちますがあります。