Script : les commentaires

1350 0
// Ceci est une ligne de commentaire

Quand la remarque possède plusieurs lignes, il est possible de faire plus rapidement  en employant la barre oblique et l’étoile

/* Ceci est une ligne de commentaire
   et une autre ligne 
   et une troisième ligne */

La couleur “crème” des lignes de commentaire en apps script différencie les commentaires des couleurs de code.

Les commentaires ou remarques n’ont aucune influence sur le déroulement du programme. Par contre, ils peuvent permettent de neutraliser certains tronçons de code. JavaScript utilise un API qui est un générateur de documentation, JSDoc, permettant de documenter les modules, les espaces de noms, les class, les méthodes, les paramètres de la méthode, etc.  Supposons que nous ayons créé une fonction personnalisée et que nous voulions ajouter des commentaires comme les fonctions natives en sont dotées.

Exemple : nous avons créé cette fonction avec de multiples arguments

function CpteparCoul(LCG,CCG,NL,NC,CC,TF,Xx)

Au bout d’un certain temps de non utilisation à quoi servent tous ces arguments ?

Alors avant la fonction dans le code nous allons écrire ces quelques lignes.

/**
* Permet de sommer le contenu des cellules de même couleur.
* @constructor
* @param {nombre} LCG - Ligne Coin Gauche.
* @param {nombre} CCG - Colonne Coin Gauche.
* @param {nombre} NL - Nombre de Lignes.
* @param {nombre} NC - Nombre de Colonnes.
* @param {"#000000"} CC - Code Couleur à Compter.
* @param {"F"} TF - Fond.
* @param {$A$1} Xx - Cellule de réinitialisation.
* @return La somme des cellules de même couleur.
* @customfunction
*/

Ceci nous donnera un dialogue d’aide lors de l’utilisation de la fonction de ce genre.

Utile non….. et professionnel en plus 😉

Attention ces commentaires doivent obligatoirement commencer par /**

mais un /* ou /*** seront rejetés ou ignorés.

Si vous avez trouvé une faute d’orthographe, veuillez nous en informer en sélectionnant le texte en question et en appuyant sur Ctrl + Entrée .

Laisser un commentaire

Ce site utilise Akismet pour réduire les indésirables. En savoir plus sur comment les données de vos commentaires sont utilisées.

Rapport de faute d’orthographe

Le texte suivant sera envoyé à nos rédacteurs :