Archives par mot-clé : Commentaire

COBOL Info

Les commentaires en COBOL

Un commentaire

Voici quelques conseils importants concernant l’utilisation des commentaires en COBOL :

  1. Soyez descriptif :
    Les commentaires doivent expliquer de manière concise et claire ce que fait une section de code. Utilisez des commentaires pour fournir des informations sur l’objectif, le contexte et la logique derrière le code.

  2. Utilisez des en-têtes de section :
    Commencez chaque section de code, telle qu’une division ou un paragraphe, par un commentaire en-tête indiquant son objectif. Cela permet aux développeurs de comprendre rapidement la fonction de cette section.

  3. Commentez les variables complexes :
    Lorsque vous déclarez des variables avec des noms complexes ou peu intuitifs, ajoutez des commentaires pour expliquer leur utilisation et leur signification. Cela facilite la compréhension du code par d’autres personnes.

  4. Documentez les algorithmes :
    Si votre code implique des algorithmes complexes ou des calculs, commentez le processus étape par étape. Cela aidera les autres développeurs (ou vous-même ultérieurement) à comprendre la logique derrière les calculs.

  5. Mettez à jour les commentaires lors de modifications :
    Chaque fois que vous apportez des modifications à votre code, assurez-vous de mettre à jour les commentaires correspondants pour refléter ces modifications. Des commentaires obsolètes peuvent être plus préjudiciables que l’absence de commentaires.

  6. Évitez les commentaires redondants :
    Inutile de commenter chaque ligne de code si le code lui-même est suffisamment explicite. Les commentaires doivent ajouter de la valeur en fournissant des informations supplémentaires.

  7. Indiquez la date et l’auteur :
    Il peut être utile d’inclure la date de création et l’auteur des commentaires, surtout si plusieurs personnes travaillent sur le même code. Cela permet de suivre les modifications et de savoir qui est responsable de chaque section.

  8. Utilisez un style de commentaire cohérent :
    Adoptez un style de commentaire cohérent dans tout votre code, que ce soit en utilisant des commentaires en ligne (avec des astérisques ou des barres obliques) ou des commentaires de bloc. La cohérence facilite la lecture.

  9. Évitez les commentaires évidents :
    Inutile de commenter des choses évidentes, comme “Cette ligne ajoute 1 à X.” Les commentaires doivent apporter des informations supplémentaires qui ne sont pas immédiatement évidentes dans le code.

  10. Utilisez des commentaires pour désactiver temporairement du code :
    Si vous devez désactiver temporairement une partie du code, utilisez des commentaires pour indiquer la raison de cette désactivation et quand vous prévoyez de la réactiver.

En suivant ces conseils, vous pouvez rendre votre code COBOL plus compréhensible, faciliter la collaboration avec d’autres développeurs et faciliter la maintenance à long terme de votre application. Les commentaires bien écrits sont une partie essentielle de la documentation de votre code.

SQL cours

Commentaires SQL

A quoi servent les commentaires ?

Les commentaires sont utilisés pour expliquer des sections d’instructions SQL ou pour empêcher l’exécution d’instructions SQL.

Comment ajouter des commentaires dans le code SQL ?

Il existe deux manières de commenter une ligne.

  1. Commentaires sur une seule ligne
  2. Commentaires multi-lignes

Voyons chaque type ci-dessous :

Commentaires sur une seule ligne :

Les commentaires sur une seule ligne commencent par “–” .

Tout texte entre “–” et la fin de la ligne sera ignoré (ne sera pas exécuté).

Exemple 1:

--Sélectionner toutes les colonnes:
SELECT * FROM Employe;

Exemple 2 :

Vous pouvez également utiliser un commentaire sur une seule ligne comme ci-dessous.

SELECT * FROM Employe;   --Sélectionner toutes les colonnes:

Commentaires multi-lignes :

Les commentaires multi-lignes commencent par /* et se terminent par */. Tout texte entre /* et */ sera ignoré.

Exemple 2 :

/*Sélectionner toutes les colonnes
de la table Employe:*/
SELECT * FROM Employe;

Vous pouvez également utiliser un commentaire multi-lignes comme ci-dessous.

SELECT Nom_Employe, /*Age,*/ Ville FROM Employe;