lala land でコーディングしていると、突然コメントに 3'd '/' を入力してしまいました。元々、コメントは2 つの '/' で緑色になります:
しかし、3 番目のダッシュでは、灰色の '///'になります。
これには何か特別な意味がありますか?それとも色が変わっただけ?
これは XmlComment を表し、詳細についてはMSDNで読むことができます。例えば、
/// <summary>
/// Method summary - a method that does something
/// </summary>
/// <param name="i">Description of param</param>
/// <param name="s">Description of param</param>
/// <returns>An object of some sort or other</returns>
public object AMethod(int i, string s)
{
}
編集: 以下に示すように、下の画像が示すように、 IntelliSenseガイダンスも提供します。
3 つのスラッシュ コメントは、ドキュメント ビルダー用です。ソースから直接 API のドキュメントを生成できます。API が何をするか、API が取るパラメーター、API がスローする例外などをソース内で文書化できます。Microsoft は、ドキュメントが実際の API と同期していることを確認するためのツールを提供しています。たとえば、パラメータを追加、削除、または名前変更した後、変更を文書化するのを忘れた場合、警告が表示されます。
これは、Visual Studio: linkを使用してこれらのタグからドキュメントを生成する方法です。
///
は XML コメント用です。XML 形式のコメントを提供します。/doc:
このようなコンパイル中にオプションを使用して、これからXMLドキュメントを作成することもできます
csc /doc:filedoc.xml program.cs