C# Language
コメントと地域

コメント

プロジェクトのコメントを使用すると、設計上の選択肢を説明する便利な方法が得られ、コードを維持したり追加したりするときに、自分の人生を楽にすることを目指すべきです。

コードにコメントを追加するには2通りの方法があります。

一行のコメント

//後に置かれたテキストはコメントとして扱われます。

public class Program
{
    // This is the entry point of my program.
    public static void Main()
    {
        // Prints a message to the console. - This is a comment!
        System.Console.WriteLine("Hello, World!"); 

        // System.Console.WriteLine("Hello, World again!"); // You can even comment out code.
        System.Console.ReadLine();
    }
}

複数の行または区切られたコメント

/*と*/間のテキストはコメントとして扱われます。

public class Program
{
    public static void Main()
    {
        /*
            This is a multi line comment
            it will be ignored by the compiler.
        */
        System.Console.WriteLine("Hello, World!");

        // It's also possible to make an inline comment with /* */
        // although it's rarely used in practice
        System.Console.WriteLine(/* Inline comment */ "Hello, World!");
  
        System.Console.ReadLine();
    }
}

地域

リージョンは折りたたみ可能なコードブロックで、コードの可読性と編成に役立ちます。

注： StyleCopのルールSA1124 DoNotUseRegionsは領域の使用を奨励します。 C＃には部分クラスやその他の機能が含まれているため、通常はひどく整理されたコードの兆候です。

リージョンは次の方法で使用できます。

class Program
{
    #region Application entry point
    static void Main(string[] args)
    {
        PrintHelloWorld();
        System.Console.ReadLine();
    }
    #endregion

    #region My method
    private static void PrintHelloWorld()
    {
        System.Console.WriteLine("Hello, World!");
    }
    #endregion
}

上記のコードをIDEで表示すると、+と - の記号を使用してコードを折りたたんで展開することができます。

拡張された

折りたたまれた

ドキュメントのコメント

XMLドキュメンテーションコメントは、ツールで簡単に処理できるAPIドキュメントを提供するために使用できます。

/// <summary>
/// A helper class for validating method arguments.
/// </summary>
public static class Precondition
{
    /// <summary>
    ///     Throws an <see cref="ArgumentOutOfRangeException"/> with the parameter
    ///     name set to <c>paramName</c> if <c>value</c> does not satisfy the 
    ///     <c>predicate</c> specified.
    /// </summary>
    /// <typeparam name="T">
    ///     The type of the argument checked
    /// </typeparam>
    /// <param name="value">
    ///     The argument to be checked
    /// </param>
    /// <param name="predicate">
    ///     The predicate the value is required to satisfy
    /// </param>
    /// <param name="paramName">
    ///     The parameter name to be passed to the
    ///     <see cref="ArgumentOutOfRangeException"/>.
    /// </param>
    /// <returns>The value specified</returns>
    public static T Satisfies<T>(T value, Func<T, bool> predicate, string paramName)
    {
        if (!predicate(value))
            throw new ArgumentOutOfRangeException(paramName);

        return value;
    }
}

IntelliSenseによってドキュメントが即座に選択されます：