C# Language
Opmerkingen en regio's

Comments

Het gebruik van opmerkingen in uw projecten is een handige manier om uitleg over uw ontwerpkeuzes achter te laten en moet erop gericht zijn uw (of iemand anders) leven gemakkelijker te maken bij het onderhouden of toevoegen van de code.

Er zijn twee manieren om een opmerking aan uw code toe te voegen.

Enkele regel opmerkingen

Elke tekst die achter // wordt geplaatst, wordt als een opmerking behandeld.

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

Meerdere regels of gescheiden opmerkingen

Elke tekst tussen /* en */ wordt als een opmerking behandeld.

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

Regio's

Een regio is een opvouwbaar codeblok dat kan helpen bij de leesbaarheid en organisatie van uw code.

OPMERKING: StyleCop's regel SA1124 DoNotUseRegions ontmoedigt het gebruik van regio's. Ze zijn meestal een teken van slecht georganiseerde code, omdat C # gedeeltelijke klassen en andere functies bevat die regio's overbodig maken.

U kunt regio's op de volgende manier gebruiken:

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
}

Wanneer de bovenstaande code in een IDE wordt weergegeven, kunt u de code samenvouwen en uitbreiden met de symbolen + en -.

Expanded

Ingestort

Documentatie opmerkingen

XML-documentatieopmerkingen kunnen worden gebruikt om API-documentatie te bieden die eenvoudig door tools kan worden verwerkt:

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

Documentatie wordt onmiddellijk opgehaald door IntelliSense: