ALL Apps Scripts

Script : les commentaires.

Ecrit par Gilbert

A la création d’un script il est parfois nécessaire de commenter le comportement du code à cet endroit ou pour toutes autres raisons nécessitant une explication ou une aide. Pour ce faire, il suffit de placer deux barres obliques devant le texte pour mettre ce texte en remarque.

// 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.

Notez cette information
[Total: 1 Average: 1]

A propos de l'auteur

Gilbert

Laisser un commentaire

Abonnez-vous à la newsletter hebdo du lundi.

Recevez chaque lundi les 7 news, trucs et astuces sur G Suite.

L'abonnement à la newsletter a été réalisé avec succès !

Share This

Share This

Share this post with your friends!