C# Language
Commentaires et régions

commentaires

Utiliser des commentaires dans vos projets est un moyen pratique de laisser des explications sur vos choix de conception et devrait viser à rendre votre vie (ou celle de quelqu'un d'autre) plus facile lors de la maintenance ou de l'ajout au code.

Il y a deux manières d'ajouter un commentaire à votre code.

Commentaires sur une seule ligne

Tout texte placé après // sera traité comme un commentaire.

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

Multi lignes ou commentaires délimités

Tout texte entre /* et */ sera traité comme un commentaire.

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

Les régions

Une région est un bloc de code réductible qui peut aider à la lisibilité et à l'organisation de votre code.

REMARQUE: la règle SA1124 DoNotUseRegions de StyleCop décourage l'utilisation de régions. Ils sont généralement le signe d'un code mal organisé, car C # inclut des classes partielles et d'autres fonctionnalités qui rendent les régions obsolètes.

Vous pouvez utiliser des régions de la manière suivante:

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
}

Lorsque le code ci-dessus est affiché dans un IDE, vous pourrez réduire et développer le code à l'aide des symboles + et -.

Étendu

S'est effondré

Commentaires sur la documentation

Les commentaires sur la documentation XML peuvent être utilisés pour fournir une documentation API qui peut être facilement traitée par des outils:

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

La documentation est instantanément captée par IntelliSense: