C# Language
Kommentare und Regionen

Bemerkungen

Die Verwendung von Kommentaren in Ihren Projekten ist eine praktische Methode, um Erklärungen zu Ihren Entwurfsentscheidungen zu hinterlassen, und sollte das Leben (oder das einer anderen Person) erleichtern, wenn Sie den Code verwalten oder ergänzen.

Es gibt zwei Möglichkeiten, dem Code einen Kommentar hinzuzufügen.

Einzeilige Kommentare

Jeder nach // platzierte Text wird als Kommentar behandelt.

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

Mehrzeilige oder begrenzte Kommentare

Jeder Text zwischen /* und */ wird als Kommentar behandelt.

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

Regionen

Eine Region ist ein ausblendbarer Codeblock, der die Lesbarkeit und Organisation Ihres Codes verbessern kann.

HINWEIS : Die StyleCop-Regel SA1124 DoNotUseRegions rät von der Verwendung von Regionen ab. Sie sind in der Regel ein Zeichen für schlecht organisierten Code, da C # Teilklassen und andere Funktionen enthält, die Regionen überflüssig machen.

Sie können Regionen auf folgende Weise verwenden:

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
}

Wenn der obige Code in einer IDE angezeigt wird, können Sie den Code mithilfe der + und - Symbole ausblenden und erweitern.

Erweitert

Zusammengebrochen

Kommentare zur Dokumentation

XML-Dokumentationskommentare können verwendet werden, um API-Dokumentation bereitzustellen, die von Tools problemlos verarbeitet werden kann:

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

Die Dokumentation wird von IntelliSense sofort abgeholt: