Génération de la documentation

classic Classic list List threaded Threaded
5 messages Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Génération de la documentation

Alarc'h
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

------------------------------------------------------------------------------
Rapidly troubleshoot problems before they affect your business. Most IT
organizations don't have a clear picture of how application performance
affects their revenue. With AppDynamics, you get 100% visibility into your
Java,.NET, & PHP application. Start your 15-day FREE TRIAL of AppDynamics Pro!
http://pubads.g.doubleclick.net/gampad/clk?id=84349831&iu=/4140/ostg.clktrk
_______________________________________________
Gambas-user-fr mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/gambas-user-fr
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: Génération de la documentation

Benoît Minisini
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

------------------------------------------------------------------------------
Rapidly troubleshoot problems before they affect your business. Most IT
organizations don't have a clear picture of how application performance
affects their revenue. With AppDynamics, you get 100% visibility into your
Java,.NET, & PHP application. Start your 15-day FREE TRIAL of AppDynamics Pro!
http://pubads.g.doubleclick.net/gampad/clk?id=84349831&iu=/4140/ostg.clktrk
_______________________________________________
Gambas-user-fr mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/gambas-user-fr
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: Génération de la documentation

Alarc'h
Le Fri, 20 Dec 2013 18:54:55 +0100,
Benoît Minisini <[hidden email]> a écrit :

> 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,
>


Merci je vais essayer ça tout de suite !

--
Marc

------------------------------------------------------------------------------
Rapidly troubleshoot problems before they affect your business. Most IT
organizations don't have a clear picture of how application performance
affects their revenue. With AppDynamics, you get 100% visibility into your
Java,.NET, & PHP application. Start your 15-day FREE TRIAL of AppDynamics Pro!
http://pubads.g.doubleclick.net/gampad/clk?id=84349831&iu=/4140/ostg.clktrk
_______________________________________________
Gambas-user-fr mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/gambas-user-fr
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: Génération de la documentation

Alarc'h
In reply to this post by Benoît Minisini
Le Fri, 20 Dec 2013 18:54:55 +0100,
Benoît Minisini <[hidden email]> a écrit :

[snip]

>
> 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,
>

Bonjour,

J'arrive sans problème à générer les commentaires d'une fonction, les commentaires d'une variable, mais pas ceux d'une classe.

Si je place un texte commençant par '' tout en haut, à l'enregistrement l'IDE rajoute automatiquemet :
' Gambas class file

donc mon commentaire ne peut être tout en haut de page.

En tout état de cause je ne vois rien dans la documentation, qu'est-ce que j'ai oublié ?

Cordialement,

--
Marc

------------------------------------------------------------------------------
Rapidly troubleshoot problems before they affect your business. Most IT
organizations don't have a clear picture of how application performance
affects their revenue. With AppDynamics, you get 100% visibility into your
Java,.NET, & PHP application. Start your 15-day FREE TRIAL of AppDynamics Pro!
http://pubads.g.doubleclick.net/gampad/clk?id=84349831&iu=/4140/ostg.clktrk
_______________________________________________
Gambas-user-fr mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/gambas-user-fr
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: Génération de la documentation

Fabien Bodard-4
C'est deux ''  au lieu de un '

normalement le commentaire devient gras

dim myVar as String ''Ceci est ma variable


''Fonction spéciale
Public sub MySub()

End



Le 22 décembre 2013 14:46, Alarc'h <[hidden email]> a écrit :

> Le Fri, 20 Dec 2013 18:54:55 +0100,
> Benoît Minisini <[hidden email]> a écrit :
>
> [snip]
>>
>> 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,
>>
>
> Bonjour,
>
> J'arrive sans problème à générer les commentaires d'une fonction, les commentaires d'une variable, mais pas ceux d'une classe.
>
> Si je place un texte commençant par '' tout en haut, à l'enregistrement l'IDE rajoute automatiquemet :
> ' Gambas class file
>
> donc mon commentaire ne peut être tout en haut de page.
>
> En tout état de cause je ne vois rien dans la documentation, qu'est-ce que j'ai oublié ?
>
> Cordialement,
>
> --
> Marc
>
> ------------------------------------------------------------------------------
> Rapidly troubleshoot problems before they affect your business. Most IT
> organizations don't have a clear picture of how application performance
> affects their revenue. With AppDynamics, you get 100% visibility into your
> Java,.NET, & PHP application. Start your 15-day FREE TRIAL of AppDynamics Pro!
> http://pubads.g.doubleclick.net/gampad/clk?id=84349831&iu=/4140/ostg.clktrk
> _______________________________________________
> Gambas-user-fr mailing list
> [hidden email]
> https://lists.sourceforge.net/lists/listinfo/gambas-user-fr



--
Fabien Bodard

------------------------------------------------------------------------------
Rapidly troubleshoot problems before they affect your business. Most IT
organizations don't have a clear picture of how application performance
affects their revenue. With AppDynamics, you get 100% visibility into your
Java,.NET, & PHP application. Start your 15-day FREE TRIAL of AppDynamics Pro!
http://pubads.g.doubleclick.net/gampad/clk?id=84349831&iu=/4140/ostg.clktrk
_______________________________________________
Gambas-user-fr mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/gambas-user-fr
Loading...