私は開発の初心者です。非常に基本的な質問をしたいと思っていましたが、C＃でコードを探していましたが、アプリケーションを再現しようとしています。ので、このコメントは、paramタグの役割を理解できません
/// <param name="requestMethod">one of GET, PUT, DELETE</param>
二& 3つのスラッシュがコメントに使用されているか、私がコメントを削除して説明するように値を配置する必要があり - ：3つのスラッシュタグは、以下の例をチェックしてください。
事前に感謝..
3つのスラッシュ///からも記事2つのスラッシュ//に対し、XMLコメントは、コード内で見つかっただけで、標準コメントされています。
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）
をライン///<param name="param1">The parameter .</param>は、このメソッドは、パラメータの詳細については
として何かを渡すことを意味してXMLメソッドの使用に関する情報はこちらをご覧ください：http://msdn.microsoft.com/en-us/magazine/cc302121.aspx
ありがとう...私が以前に言及したように、///の後にparamタグがあると、コメントを削除する必要があるか、またはスクリプトの後ろに追加するparam値があると思います。 –
@MohdWasiHirekudi私は持っています私の答えにいくつかの情報を追加しましたが、基本的にParamラインが表示されている場合は、そのメソッドを呼び出すとパラメータを渡すことを意味します。また、XMLコメントはメソッドの動作とは関係がないため、コメントを削除するとパラメータを渡す必要はありません – Purplegoldfish
これはコメントだけの特別な種類です。
Visual Studioでは、メソッドの上に///を押すと、現在のメソッドに基づいて自動的に情報が作成されます。
これは文書化に使用され、/ docコマンドラインオプションを使用して、この情報を含むxmlファイルを生成するようにコンパイラに指示することができます。
は、Microsoftの勧告を参照してください：
それはdocumenting codeのためです。
上記のリンクから：「PARAM」のタグはあなたの例では、各パラメータ
を定義
、文書が
requestMethodに渡すことができる値を記述しています。メソッドのシグネチャを見ることなく、これらの値が文字列GET,PUT、およびDELETEか、おそらくC＃enum値かどうかを判断するのは難しいです。参照MSDN
これは、mvc-controllerのメソッドにアクセスする方法についてのコメントのようですこれまでどおり、周囲のコードがなくても、それが正確に何であるかを知ることは難しいです。あなたのコメントのために – ChriPf