Ajouter des commentaires exploitables avec NDOC en C#

/// <summary>
/// Description de la méthode
/// </summary>
/// <remarks>
/// Remarques concernant cette méthode
/// <seealso cref="System.String"/>
/// </remarks>
/// <param name="pValue">Pour chaque paramètre, le décrire comme ici</param>
/// <returns>Indiciation sur la valeur retournée</returns>
/// <example><code>Exemple d'utilisation de cette méthode</code></example>
private bool IsEmpty(Glass myGlass) {
// Code de la méthode
}

De cette manière, lorsque vous utiliserez votre méthode ailleurs dans le code, Visual Studio vous affichera le summary.
Si vous utilisez NDoc, il vous créera une documentation similaire à la MSDN de Microsoft pour votre application.

PS : On aime ou pas la présentation de la MSDN, c’est quand même mieux que rien ;-)

Laisser un commentaire

Vous devez être connecté pour laisser un commentaire.