C# Language
Комментарии и регионы

Комментарии

Использование комментариев в ваших проектах - это удобный способ оставить объяснения ваших вариантов дизайна и постараться облегчить вашу (или чужую) жизнь при сохранении или добавлении кода.

Есть два способа добавить комментарий к вашему коду.

Комментарии к одной строке

Любой текст, помещенный после // будет рассматриваться как комментарий.

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: