Script : les commentaires

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.

personnes ont consulté cet article

1 minute

Rédigé par Gilbert ROINEL - il y a 5 ans

Script : les commentaires

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

Veuillez créer un compte pour lire la suite de cette ressource

L’accès à cette ressource se fait gratuitement en créant un compte Numerifan. Les abonnements payants donnent également accès aux cours gratuits.

Paywall image

Cet article est réservé aux abonnés. Pourquoi ?

Fournir tout ce contenu nous demande beaucoup de temps, des ressources et une veille permanente. Accédez à ce contenu en rejoignant notre super communauté, pour tous nous remercier 💪

Rédacteur

S’abonner
Notification pour
guest
0 Commentaires
Commentaires en ligne
Afficher tous les commentaires