ICS4U - Unité 1 - Activité 2 - La documentation interne du code source - Génie informatique

Les commentaires sont des énoncés placés dans un programme qui servent à expliquer certains codes particulier et certaines parties du programme mais qui ne sont pas exécutés par le programme.

Les commentaires sont importants dans un programme, spécialement ceux de grande envergure, puisqu'ils permettent de donner des spécifications sur les codes employés et aussi, au programmeur original ou encore à un programmeur qui a le tâche d'effectuer une mise-à-jour sur le programme, de comprendre les raisons de toutes les sections du programme.

Les codes de commentaires peuvent aussi servir lors du débogage d'un programme car il est ainsi possible de mettre certaines lignes de codes sous forme de commentaires afin d'isoler certaines autres lignes de codes pour vérifier leur fonctionnement.

Il existe quatre types de commentaires dans le langage C# :

Commentaire
de ligne

Ce type de commentaire débute par deux barres-obliques vers l'avant // et se termine par un retour à la ligne, c'est-à-dire avec la fin d'une ligne.

Exemple :

System.out.println("Allo"); // Commentaire de ligne

Commentaire
de liste de tâches

Ce type de commentaire débute aussi par deux barres-obliques vers l'avant // et se termine à la fin d'une ligne mais si les deux barres-obliques sont immédiatement suivies par le mot TODO , ce commentaire apparaît dans la liste de tâches.

Ce type de commentaire est surtout employé en guise de rappel des modifications à apporter avant la compilation finale du programme.

Exemple :

System.out.println("C#"); // TODO - À modifier.

Commentaire
de bloc

Ce type de commentaire débute par une barre-oblique suivie d'un astérisque /* et se termine par un astérisque suivi d'une barre-oblique */ .

Un commentaire de ce type peut apparaître sur une seule ligne, avant ou après une ligne de code exécutable ou encore s'étendre sur plusieurs lignes.

Exemple :

System.out.println("Commentaires");
/* Commentaire
de bloc qui
s'étend sur plusieurs lignes. */

Commentaire
C#doc

Ce type de commentaire est semblable à celui d'un commentaire de bloc sauf que celui-ci s'affiche dans la fenêtre Structure de la classe et peut être capté pour produire une documentation externe dans un format HTML. Ce commentaire débute par une barre-oblique vers l'avant suivie de deux astérisques /** et se termine par un astérisque suivi d'une barre oblique */ .

Exemple :

System.out.println("Commentaires");
/** Commentaire de bloc qui
s'étend sur plusieurs lignes
et qui apparaît dans la fenêtre
Structure de la classe. */

UNITÉ 1 - ACTIVITÉ 2 LA DOCUMENTATION INTERNE DU CODE SOURCE

UNITÉ 1 - ACTIVITÉ 2

LA DOCUMENTATION INTERNE DU CODE SOURCE