Section courante

A propos

Section administrative du site

Les remarques

Le langage Free Pascal support trois formats de remarque. Le premier format à les syntaxes suivantes :

(* ma remarque *)

ou

(* ma remarque
étalé sur plusieurs lignes
... *)

Le deuxième format à les syntaxes suivantes :

{ ma remarque }

ou

{ ma remarque
étalé sur plusieurs lignes
... }

Comme les syntaxes le démontre on peut étirer les commentaires sur plusieurs lignes ou simplement la mettre sur une ligne, le Free Pascal n'y voit aucune différence.

La troisième n'affecte que la ligne courante du code source. Donc, lorsqu'on se retrouve à la ligne suivante, les instructions régulière reprenne et la remarque n'a plus court. Finalement, son format à la syntaxe suivante :

// ma remarque

Exemple

Voici un exemple typique de l'utilisation de cette possibilité :

  1. Program RemSamples;
  2.  
  3. BEGIN
  4.   { Ceci est un commentaire n'étant pas vue }
  5. END.

FpDoc

L'utilisation des commentaires pour être compatible avec l'IDE et le générateur de document est normalement le FpDoc proposé par Free Pascal. Il est cependant peut utilisé étant donné qu'il fait référence à un fichier XML externe.

PasDoc

L'utilisation des commentaires la plus confortable afin qu'il soit utilisable par un document est proposé par PasDoc également. Il utilise les balises suivantes pouvant être inclus dans des commentaires normales du code source Free Pascal :

Balise Description
@anchor Cette balise permet d'indiquer une ancre à cet endroit.
@abstract Cette balise permet d'indiquer une brève description pour les classes et les unités.
@author Cette balise permet d'indiquer l'auteur de l'élément de structure.
@bold Cette balise permet d'indiquer une texte en gras.
@br Cette balise permet d'indiquer qu'il faut mettre un saut de ligne dans la sortie HTML généré.
@cell Cette balise permet d'indiquer une des cellules d'une ligne d'un tableau.
@classname Cette balise permet d'indiquer le nom de la classe courant.
@code Cette balise permet d'indiquer une courte partie de code source ou un identificateur.
@created Cette balise permet d'indiquer la date de création.
@cvs Cette balise permet d'indiquer une ligne de texte généré par CVS ou SVN.
@definitionList Cette balise permet d'indiquer une liste définition.
@deprecated Cette balise permet d'indiquer que l'élément de structure est obsolète.
@exclude Cette balise permet d'indiquer un élément ne devant pas figurer dans la documentation.
@false Cette balise permet d'indiquer une valeur fausse (false) dans un paramètre.
@html Cette balise permet d'indiquer un bout de code HTML à passer directement dans la documentation.
@image Cette balise permet d'indiquer une image à inclure dans la documentation.
@includeCode Cette balise permet d'indiquer une inclusion d'un fichier externe de code dans la documentation.
@inherited Cette balise permet d'indiquer le nom de la méthode ancêtre sinon de la classe ancêtre.
@inheritedClass Cette balise permet d'indiquer le nom de la classe ancêtre.
@include Cette balise permet d'indiquer une inclusion d'un fichier de description dans la documentation.
@item Cette balise permet d'indiquer un élément dans une liste.
@itemLabel Cette balise permet d'indiquer un étiquette d'élément dans une liste.
@itemSetNumber Cette balise permet de fixer un numéro dans une liste d'éléments.
@itemSpacing Cette balise permet d'indiquer un espace entre 2 lignes consécutives.
@longcode Cette balise permet d'indiquer un exemple de code préformaté ne devant pas changer vers la sortie.
@name Cette balise permet d'indiquer le nom de l'élément courant.
@italic Cette balise permet d'indiquer une texte en italique.
@lastmod Cette balise permet d'indiquer la date de la dernière modification.
@latex Cette balise permet d'indiquer un sortie de format LaTeX.
@link Cette balise permet d'indiquer un lien vers une autre élément.
@member Cette balise permet d'indiquer un membre d'une classe.
@nil Cette balise permet d'indiquer une valeur NIL dans un paramètre.
@orderedList Cette balise permet d'indiquer une liste d'éléments ordonné.
@param Cette balise permet d'indiquer un paramètre d'une méthode ou d'une fonction.
@preformatted Cette balise permet d'indiquer qu'il soit copié intégralement le commentaire sans modification, soit un équivalent de la balise PRE du HTML.
@raises Cette balise permet d'indiquer une marque de description d'une exception provoquée à l'intérieur d'une fonction.
@return Cette balise permet d'indiquer la valeur de retour d'une méthode ou d'une fonction.
@row Cette balise permet d'indiquer une ligne d'un tableau.
@rowHead Cette balise permet d'indiquer une ligne d'entête d'un tableau.
@section Cette balise permet d'indiquer le début d'une nouvelle section.
@seealso Cette balise permet d'indiquer une référence vers une association à un élément de structure.
@shortTitle Cette balise permet d'indiquer un court titre de l'introduction / de la conclusion
@shortTitle Cette balise permet d'indiquer un court titre de l'introduction / de la conclusion
@table Cette balise permet d'indiquer un tableau avec des lignes, des colonnes et des cellules.
@tableOfContents Cette balise permet d'indiquer qu'il faut insérer une table de contenu à cet endroit.
@title Cette balise permet d'indiquer un titre de l'introduction / de la conclusion
@true Cette balise permet d'indiquer une valeur vrai (true) dans un paramètre.
@unorderedList Cette balise permet d'indiquer une liste d'éléments désordonné.
@value Cette balise permet d'indiquer une valeur dans une énumération.

Exemple

L'exemple suivant permet d'indiquer le nom de l'auteur et une description du programme reconnu par PasDoc :

  1. { @author(Sylvain Maltais <support@gladir.com>)
  2.   @abstract(Exemple de commentaires pour PasDoc)
  3. }
  4.  
  5. Program RemPasDocSamples;
  6.  
  7. BEGIN
  8. END.

Dernière mise à jour : Samedi, le 13 février 2016