1)
Je trouve la règle de syntaxe suivante peu pratique, surtout pour une description d'une ligne :
{*-
Texte
-}
Il n'est pas possible de faire simplement
{*-Texte-}
Ce qui fait que le code source est très 'aéré' et demande plus d'opérations de scrolling lors de la visualisation.
2)
Le texte du commentaire est filtré, dans l'exemple suivant la ligne vide (CRLF) n'est pas
prise en compte par la compilateur CHM :
{*-
Ligne 1
Ligne 2
atEnum1 : comment
atEnumNomPlusLong : Comment
-}
A noter que les espaces sont aussi supprimés mais je ne pense pas que tu puisse y faire qq chose :/
3)
Il est regrettable de ne pouvoir commenter une énumération comme un record.
Ceci fonctionne :
{*-
Record contenant la configuration de l'application, précisée dans le fichier .ini
-}
ConfigurationIni=Record
Debug : Boolean; /// Affichage ou non d'informations de debug
...
end;
mais pas ceci :
{*-
Défini le type de traitement à effectuer lors d'une opération d'Import/Export
-}
TTypeTraitement=(
ttExportReferentiel, /// test de commentaire
...);
4)
Et enfin dans la partie "Source code" de la doc génèrée il serait bien de garder la mise en forme du code source, enfin si tu as la main là-dessus.
Voilà c'est tout pour aujourd'hui. Et encore bravo pour ton soft.
Laurent Dardenne
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Salut Trident,
voici qq remarques :
1)
Je trouve la règle de syntaxe suivante peu pratique, surtout pour une description d'une ligne :
{*-
Texte
-}
Il n'est pas possible de faire simplement
{*-Texte-}
Ce qui fait que le code source est très 'aéré' et demande plus d'opérations de scrolling lors de la visualisation.
2)
Le texte du commentaire est filtré, dans l'exemple suivant la ligne vide (CRLF) n'est pas
prise en compte par la compilateur CHM :
{*-
Ligne 1
Ligne 2
atEnum1 : comment
atEnumNomPlusLong : Comment
-}
A noter que les espaces sont aussi supprimés mais je ne pense pas que tu puisse y faire qq chose :/
3)
Il est regrettable de ne pouvoir commenter une énumération comme un record.
Ceci fonctionne :
{*-
Record contenant la configuration de l'application, précisée dans le fichier .ini
-}
ConfigurationIni=Record
Debug : Boolean; /// Affichage ou non d'informations de debug
...
end;
mais pas ceci :
{*-
Défini le type de traitement à effectuer lors d'une opération d'Import/Export
-}
TTypeTraitement=(
ttExportReferentiel, /// test de commentaire
...);
4)
Et enfin dans la partie "Source code" de la doc génèrée il serait bien de garder la mise en forme du code source, enfin si tu as la main là-dessus.
Voilà c'est tout pour aujourd'hui. Et encore bravo pour ton soft.
Laurent Dardenne
1/ Sur une ligne tu peux utiliser le triple slash par exemple :
const
/// MOn commentaire
maConstante : string;
...ou bien..
const
maConstante : string; /// MOn commentaire
2/ POur garder les lignes vides, coche l'option "Allow HTML in description".
3/ Oui, je travaille déja sur les enum et cela arrivera sur la prochaine version.
4/ Dans la partie sourcecode, oui, j'ai deja un Tracker la dessus ... il faut que je le corrige, c'est agaçant.
Merci pour ces remarques Laurent, je me remets au travail :)