Il existe trois notations différentes pour écrire des commentaires dans un programme SAS. Chacune à ses avantages et ses limites. En en prenant connaissance ici, vous pourrez faire des choix stratégiques.

1. Désactiver une instruction : un commentaire entre une étoile et un point virgule est la plus rapide des notations. Celle-ci fait usage de la particularité de la syntaxe SAS. En effet, chaque instruction se termine par un point-virgule. En ajoutant une étoile (asterisk) en tête, l’instruction est désactivée.

Lors du développement d’un programme, on est amené à suspendre certaines instructions ou à en activer ponctuellement. C’est le cas la procédure PROC PRINT, qui permet d’avoir un aperçu du contenu d’un jeu de donné. 

*proc print data=cnt_pct;
*run;

Note : On n’utilisera pas cette syntaxe étoile/point-virgule :

• pour suspendre un large bloc de texte
• si les guillemets ne sont pas fermés dans le commentaire
• entre deux instructions PUT ou deux instructions CALL EXECUTE.

2. Désactiver un bloc de texte plus globales : L’étoile/point-virgule  peut-être incluse dans d’autres  commentaires plus larges définis pas /* */. Ainsi on peut choisir d’annoter des titres de rubriques d’un programme avec *; . Ainsi on pourra englober ces titres dans une zone de désactivation plus grande.

/*
*Calcul des fréquences;
proc freq…;
run;

*Générer une table;
proc report…;
run;
*/

Note : On pourra choisir de fermer le bloc par /***/ au lieu de */. Ainsi, en enlevant seulement le /* en début de commentaire, l’intégralité du code est réactivée et fonctionne sans que la notation de fin soit impérativement supprimée.

3. Les commentaires et le langage macro :

Les différences entre les instructions à l’intérieur et la l’extérieur d’une définition de macro : les instructions macro doivent avoir l’étoile après le symbole pourcentage à l’intérieur d’une définition de macro. On continuera à mettre l’étoile avant si l’instruction est à l’extérieur de la définition de macro. La notation /**/ ne rencontre pas de difficulté particulière.

%macro commentaires;
%*IF….;
%mend;
*%commentaires;

Le cas particulier des conditions : seul le /**/  peut-être utilisé entre un %if et un %else.

%macro commentaire;
   %IF … %THEN %DO; … %END;
 /* l’autre notation n’est pas possible ici*/ 
  %ELSE …
%mend commentaire;

Une macro sans nom : la troisième méthode pour écrire un commentaire est de créer une macro sans nom.

%macro;
Mon texte est inactif ici.
%mend;

Que vous programmiez en SAS, en C++, en Java ou en Visual Basic, la qualité d’un programme commence par l’utilisation de commentaires. Ceux-ci doivent être compréhensibles par les non-spécialistes. L’entête est le premier élément à apparaître dans votre programme. Les étapes de votre programme se doivent d’être lisibles sans avoir à se plonger dans chaque ligne individuelle de code.

1. Préférez un nom de programme parlant : dans le milieu pharmaceutique, les tableaux et listings suivent des règles précises. Celles-ci assurent une cohérence entre les projets ou pour répondre à des contraintes techniques. Par exemple, ‘pp’ pourra être inclus dans le nom pour préciser la population à laquelle réfère le tableau est Per Protocol, ou encore, les noms de programmes pourront apparaître en minuscule.

2. Positionnez votre programme dans son projet : il est rare d’écrire un seul programme pour un projet. Le nom du projet auquel appartient le programme pourra ainsi figurer en premier.

3. Clarifiez l’objectif de votre programme : qu’il s’agisse le titre d’un tableau statistique “Nombre de patients par centre, âge et sexe” ou le rôle d’une macro “Créer des fichiers XML à partir de jeux de données SAS”, l’objectif du programme doit être explicitement défini.

4. Listez les grandes étapes du programme : vous pourrez compléter cette rubrique en fin de programmation en exploitant les grands titres numérotés.

5. Renvoyez votre lecteur vers les références documentaires : le protocole d’une étude statistique (protocol), le cahier d’observation électronique annoté (eCRF), le descriptif détaillé du programme (specification) sont des sources de documentation possibles.

6. Enumérez vos entrées/sorties : listez les données que vous exploitez dans votre programme et les fichiers permanents que vous crées.

7. Prévenez des limites du programme : les contraintes techniques comme la version SAS requise au minimum ou le système d’exploitation ont leur place dans l’entête.

8. Datez et signez vos programmes : En plus du nom des auteurs et les dates de création et de modifications, on trouvera l’inventaire des changements intervenus.

Vous venez de voir 8 informations clés pour votre entête. Cette liste n’est pas exhaustive. Elle doit s’adapter au cas par cas. Par exemple, votre client ou votre entreprise aura probablement une liste prédéfinie des critères à faire figurer. Afin d’éviter les oublis, vous pourrez faire l’usage d’un modèle d’entête.

Tel un menu, les commentaires donnent une vue d’ensemble de votre programme SAS. Par la suite, vous devez expliquer les étapes de votre développement. Mais comment agencer votre code ? Voici un exemple extrait de la pharmaceutique. Il s’agit de créer un tableau statistique extrait de données sur les essais cliniques.

1. Des valeurs rapidement accessibles pour la maintenance du programme : dans cette première section figurent les informations utilisables à tout moment dans le programme. Voici quelques exemples de mises à jour :

• changement de répertoire de vos données ou programmes ;
• changement des labels apposés sur vos données codifiées ;
• pour connaître les valeurs prises par vos variables macros.

Suivre cette convention aidera les autres programmeurs à se familiariser avec votre travail.

2. Regrouper les informations : l’information à publier est, le plus souvent, à recueillir parmi plusieurs jeux de données. Il vous faudra donc les combiner. Par exemple, les données démographiques sur les patients seront à ajouter aux résultats de laboratoire. Si seule une sous population vous intéresse, il faudra supprimer les champs inutiles.

3. Extraire les statistiques : cette section peut inclure le calcul de simples fréquences et pourcentages. Elle peut aussi faire l’objet du calcul de tests statistiques.

4. Mettre en forme les résultats : chaque tableau devra suivre une mise en page précise. Les titres devront être adaptés à chaque tableau et ces dérivés. Les données codées se verront remplacées par du texte via des formats. L’ensemble pourra être lu par des éditeurs de texte ou sur des fichiers Internet.

5. Nettoyage : enfin vous pouvez faire du nettoyage en supprimant toutes les données temporaires, qu’il s’agisse de jeux de données, de catalogues, de fichiers .log ou de noms reconnus comme chemin d’accès à une bibliothèque de données. Ce travail vous sera d’autant plus bénéfique que vous exécuterez plusieurs programmes à la suite des uns des autres. Cela vous évitera de mauvaises surprises dues à l’utilisation involontaire de données en mémoire.

Tout au long de ces cinq étapes, vous ponctuerez votre code de commentaires. Un programme s’allonge très rapidement même s’il est bien écrit. Pour un simple tableau statistique en essai clinique il n’est pas rare de voir l’équivalent d’une dizaine d’écrans. Pour naviguer rapidement d’une section à l’autre, rien de tel que de numéroter vos commentaires. Un programme SAS est composé principalement de deux groupes de texte (data step et procedure). Commentez chacun bloque de texte. Par exemple, “extraire pour chaque effet secondaire, le nombre de patient l’ayant vécu”. Si une étape est inhabituelle, fournissez les raisons.