C# Language
Komentarze i regiony

Komentarze

Używanie komentarzy w swoich projektach jest wygodnym sposobem na pozostawienie wyjaśnień dotyczących wyborów projektowych i powinno mieć na celu ułatwienie życia (lub innej osobie) podczas konserwacji lub dodawania do kodu.

Istnieją dwa sposoby dodawania komentarza do kodu.

Komentarze jednowierszowe

Każdy tekst umieszczony po // będzie traktowany jako komentarz.

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();
    }
}

Komentarze wielowierszowe lub rozdzielane

Każdy tekst pomiędzy /* i */ będzie traktowany jako komentarz.

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();
    }
}

Regiony

Region to składany blok kodu, który może pomóc w czytelności i organizacji kodu.

UWAGA: Reguła StyleCop SA1124 DoNotUseRegions odradza korzystanie z regionów. Zazwyczaj są one oznaką źle zorganizowanego kodu, ponieważ C # zawiera klasy częściowe i inne funkcje, które powodują, że regiony stają się przestarzałe.

Możesz użyć regionów w następujący sposób:

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
}

Gdy powyższy kod jest wyświetlany w IDE, będziesz mógł zwinąć i rozwinąć kod za pomocą symboli + i -.

Rozszerzony

Upadł

Komentarze do dokumentacji

Komentarze do dokumentacji XML można wykorzystać do zapewnienia dokumentacji API, którą można łatwo przetwarzać za pomocą narzędzi:

/// <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;
    }
}

Dokumentacja jest natychmiast pobierana przez IntelliSense: