私は突然私がコメントに3'd '/'をタイプしたときにララの土地に沿ってコーディングしていました。もともとのコメントは2 '/' sのでグリーンを行く:3 '/'は連続してC#で何をするのですか?
しかし、第三ダッシュで、それはグレー '///' を行く:
具体的な意味はありますか?それとも色が変わったのか?
私は突然私がコメントに3'd '/'をタイプしたときにララの土地に沿ってコーディングしていました。もともとのコメントは2 '/' sのでグリーンを行く:3 '/'は連続してC#で何をするのですか?
しかし、第三ダッシュで、それはグレー '///' を行く:
具体的な意味はありますか?それとも色が変わったのか?
これは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ガイダンスを提供します。
ドキュメンテーションを生成するだけでなく、Visual StudioのIntellisenseポップアップの詳細も提供することに言及する価値があります。 –
良いアイデアが追加されました。 – glosrob
うまくやった。あなたはどのようにその配色で働いていますか;) –
スリースラッシュのコメントはドキュメントビルダーのためのものです。ソースから直接APIのドキュメントを生成することができます。あなたのAPIが何をしているか、どのパラメータをとるか、例外がスローされるかなどをあなたのソースに書かせることができます。 Microsoftは、ドキュメントが実際のAPIと同期していることを確認するためのツールを提供しています。たとえば、パラメータの追加、削除、または名前の変更を文書化するのを忘れた場合は、警告が表示されます。
Visual Studioを使用してこれらのタグからドキュメントを生成する方法は、linkです。
///
はXMLコメント用です。 XML形式のコメントを提供します。
csc /doc:filedoc.xml program.cs
もちろん、「///」は色のところです。もちろん、このようにコンパイルするときに
/doc:
オプションを使用してXML文書を作成することもできます。 – Joey