Le langage de programmation C# (C Sharp) supporte deux formats de remarque. Le premier format à les syntaxes suivantes :
| /* ma remarque */ |
ou
|
/* ma remarque étalé sur plusieurs lignes ... */ |
Comme la seconde syntaxe le démontre on peut étirer les commentaires sur plusieurs lignes ou simplement la mettre sur une ligne, le C# (C Sharp) n'y voit aucune différence.
Le deuxième n'affecte que la ligne courante du code source. Donc, lorsqu'on se retrouve à la ligne suivante, les instructions régulière reprenne et la remarque n'a plus court. Finalement, son format à la syntaxe suivante :
| // ma remarque |
Remarque Visual Studio
Il existe une syntaxe que l'on peut utiliser pour les remarques afin qu'il soit reconnu par l'IDE de Visual Studio mais pas par le compilateur. Ce format de remarque sera fort utile pour entretenir un gros projet. Ainsi, il sera possible grâce à ces remarques de reconnaître ce que vos méthodes font et la signification de chacun des paramètres et leur valeur de retour. Voici sa syntaxe :
|
/// <summary> /// description de la méthode /// </summary> /// <param name="param1">remarque sur le parametre 1</param> /// <param name="param2">remarque sur le parametre 2</param> /// <param name="...">...</param> /// <returns>remarque sur le retour de la fonction</returns> |
Les balises du tableau suivant sont reconnues par le compilateur :
| Balise | Description |
|---|---|
| <c> | Marque le texte dans une ligne sous forme de code, par exemple, <c>int i = 74;</c>. |
| <code> | Marque plusieurs lignes comme code. |
| <example> | Marque un exemple de code. |
| <exception> | Documente une classe d'exception. (La syntaxe est vérifiée par le compilateur.) |
| <include> | Inclut des commentaires provenant d'un autre fichier de documentation. (La syntaxe est vérifiée par le compilateur.) |
| <list> | Insère une liste dans la documentation. |
| <para> | Donne une structure au texte. |
| <param> | Marque un paramètre de méthode. (La syntaxe est vérifiée par le compilateur.) |
| <paramref> | Indique qu'un mot est un paramètre de méthode. (La syntaxe est vérifiée par le compilateur.) |
| <permission> | Accès aux documents à un membre. (La syntaxe est vérifiée par le compilateur.) |
| <remarks> | Ajoute une description pour un membre. |
| <returns> | Documente la valeur de retour d'une méthode. |
| <see> | Fournit une référence croisée à un autre paramètre. (La syntaxe est vérifiée par le compilateur.) |
| <seealso> | Fournit une section «voir aussi» dans une description. (La syntaxe est vérifiée par le compilateur.) |
| <summary> | Fournit un bref résumé d'un type ou d'un membre. |
| <typeparam> | Décrit un paramètre de type dans le commentaire d'un type générique. |
| <typeparamref> | Fournit le nom du paramètre de type. |
| <value> | Décrit une propriété. |
Exemple
Voici un exemple typique de l'utilisation de cette fonction :
Essayer maintenant !