2

私は開発に不慣れで、非常に基本的な質問をしたいと思っていました。C＃でコードを探していて、3つのスラッシュが付いたparamタグに出くわしたときに何をすべきかわからないアプリケーションを再現しようとしていました。以下の例を確認してください。 - 

/// <param name="requestMethod">one of GET, PUT, DELETE</param>

コメントには2つと3つのスラッシュが使用されているので、これはコメントですか、コメントを削除して説明どおりに値を入力する必要があります。

前もって感謝します..

4

3 に答える 3

1

コードを文書化するためのものです。

上記のリンクから：

'param'タグは各パラメータを定義します

あなたの例では、ドキュメントはに渡すことができる値を説明していますrequestMethod。メソッドのシグネチャがないと、これらの値が文字列、、、またはC＃の列挙値であるかどうかを判断するのはGET困難ですPUT。DELETE

MSDNの記事も参照してください

于 2012-05-02T10:23:43.573 に答える
1

3つのスラッシュ///はXMLコメントですが、2つのスラッシュ//はコードにある単なる標準コメントです。

ご覧のとおり、3つのスラッシュが付いたXMLコメントにはメソッド全体に関する情報が含まれていますが、//メソッド本体のコメントはそのメソッドの一部に関するコメントにすぎません。

/// <summary>
/// Does something.
/// </summary>
///<param name="param1">The parameter .</param>
public void doSomething(int param1)
{
     // This is a standard comment about some code

}

したがって、このメソッドを呼び出すときは、次のようにします。

doSomething（999）

Line ///<param name="param1">The parameter .</param>は、このメソッドがパラメータとして何かを渡すことを期待していることを意味します

XMLメソッドの使用の詳細については、http：//msdn.microsoft.com/en-us/magazine/cc302121.aspxを参照してください。

于 2012-05-02T10:26:09.770 に答える
0

これは特別な種類のコメントです。

Visual Studioでは、メソッドの上で///を押すと、現在のメソッドに基づいて情報が自動的に作成されます。

これはドキュメント化に使用され、/docコマンドラインオプションを使用してこの情報を含むxmlファイルをコンパイラーに生成させることができます。

Microsoftの推奨事項を参照してください。

http://msdn.microsoft.com/en-us/library/5ast78ax.aspx

于 2012-05-02T10:22:52.193 に答える