Re: [Gambas-user-fr] Génération de la documentation

[Benoît M. <ga...@us...>]

Le 20/12/2013 18:10, Alarc'h a écrit :
> Bonjour à tous,
>
> une question sans doute très bête... dans l'IDE de gambas je viens de
> m'aperçevoir que lorsque l'on ouvre le navigateur d'aide on peut le
> scinder en deux et avoir accès à l'arborescence de documentation des
> modules du projet en développement et du projet lui-même. Je vois
> donc apparaître mes classes dans le format de doc de gambas. Je
> comprends que le programme de documentation extrait tout ça des
> sources.
>
> Par contre sur le site de documentation de Gambas il y a pour
> certains éléments du texte, des exemples et autres documentations. Je
> voulais savoir si cela s'obtenait avec des commentaires formatés
> genre doxygen (et alors quel format ?) ou par un autre moyen ?
>
> Est-ce que je peux documenter mes méthodes et fonctions au fur et à
> mesure du développement de façon automatique ? J'avoue que je n'ai
> pas trouvé l'astuce, mais lire tout le code source de Gambas ne se
> fait pas en cinq minutes et si quelqu'un pouvait me mettre sur la
> voie ça m'aiderait bigrement.
>
> Merci d'avance
>
> -- Marc
>

Les commentaires d'aide sont marqués par une double apostrophe. Ils 
utilisent une syntaxe de type "MarkDown".

L'aide d'une fonction doit la précéder.

L'aide d'une variable ou d'une propriété peut se trouver sur la même 
ligne que sa déclaration.

L'aide d'une classe doit se trouver tout en haut du fichier source.

Cordialement,

-- 
Benoît Minisini