Aller au contenu

javadoc en c


Neo_13

Messages recommandés

Salut,

J'ai hésité entre ici et logiciels

Aujourd'hui, en TP de C, mon prof m'a parlé de javadoc, dont j'ignore tout et dont, à la limite je me tape complètement, puisque je fais du C et non du java.

Néanmoins, il semble que ce logiciel, génère des choses intéressantes à partir des commentaires inclus dans un source java, à partir de quelque chose qui ressemble à :

/**
* fonction
* Fonction qui sert à fonctionner
*
* @param type nom description
* @return type nom description
*/

à savoir une page HTML...

Existe-t-il quelque chose de semblable pour des sources C, appliquant la même convention, ou une convention semblable, le tout gratuit et de préférence open source et sous linux

(ces trois paramètres ne sont pas indispensables, en particulier l'open source)

Quelqu'un connait ?????

Lien vers le commentaire
Partager sur d’autres sites

Je connais Javadoc

ça te permet de générer une documentation pour tes fonctions

ça te donne le résultat que tu peux voir sur le site de Sun pour la description des fonctions Java

il te suffit de faire

/**
blablabla
*/

Mais je n'ai jamais vu la même chose pour d'autres langages..

quoique ca semble pas trop compliquer à coder....

Lien vers le commentaire
Partager sur d’autres sites

Mais je n'ai jamais vu la même chose pour d'autres langages..

quoique ca semble pas trop compliquer à coder....

C'est pour ça que je me demandais si ça existait...

Je me demande même si javadoc ne ferait pas l'affaire...

Et si en plus ça existait en ebuild pour gentoo, ce serait le top...

Lien vers le commentaire
Partager sur d’autres sites

Je comprend pas trop comment ça marche pour l'instant... si quelqu'un a un tuto ultra bref, je suis preneur, sinon, ben je continuerais avec la doc de doxygen.org... mais ca fait un peu la bommbe atomique pour écraser le moustique, se taper cette doc ultra épaisse... mais s'il faut en passer par là...

Non, personne n'a de tuto simplifié????

Lien vers le commentaire
Partager sur d’autres sites

J'ai trouvé un "javadoc" pour Delphi

mais ce n'est pas Open source, ni gratuit

Javadoc pour Delphi

Pour Ada :

Adadoc

AdaBrowse

Pour Doxygen :

C++, C, Java, Objective-C, IDL et sans doute PHP, C# et D.

http://www.stack.nl/~dimitri/doxygen/

Liens d'éditeurs de documentations (commerciaux et non commerciaux)

http://www.stack.nl/~dimitri/doxygen/links.html

Lien vers le commentaire
Partager sur d’autres sites

en fait j'ai install (emerge -u doxygen) mais là, première loose... Je suis sous Gnome... Donc DL et compilation de Qt (long) puis doxygen pas de stress...

Il a l'air vraiment puissant comme truc... seulement il faut faire un fichiers de config, et en fait, ce qui m'aiderais c'est d'en trouvez un déjà fait... histoire de pouvoir voir la syntaxe et autre et de pouvoir faire le mien...

En tout cas, ca a l'air vraiment bien, ce truc...

EDIT : je viens de lui faire générer un fichier de config par défaut...

en TNR 10 deux colonnes par pages, deux pages par feuille, et 1cm de marge seulement... 6feuilles... J'ai de la lecture pour le week end

donc l'intant, mes commentaires sont comme ça :

/**
* nom de la fonction
* description de la fonction
*
* @param type nom description
* @param type nom description
* @return type nom eventuellement commentaire sur le retour
*/

Lien vers le commentaire
Partager sur d’autres sites

  • 5 semaines après...

salut

deja voila mon fichier config (il est tt simple tu dois avoir le meme) :

EXTRACT_ALL = YES

EXTRACT_PRIVATE = NO

EXTRACT_STATIC = NO

#EXTRACT_LOCAL_METHODS = YES

HIDE_UNDOC_MEMBERS = YES

#------------------------------------------

#Input related options

INPUT = /home/projet/

FILE_PATTERNS = *.c *.h

#------------------------------------------

#HTML related options

GENERATE_HTML = YES

#------------------------------------------

#LaTeX related options

GENERATE_LATEX = NO

#------------------------------------------

#Alphabetical index options

ALPHABETICAL_INDEX = YES

IGNORE_PREFIX = check_

COLS_IN_ALPHA_INDEX = 2

Je voulais savoir toi qui a fait du doxygen depuis un pti mois si tu connaissait le moyen de lui faire generer uniquement la doc des fonctions commentées parce que jai un gros projet en C et je me fout d'avoir la liste complete des variables et autres fonctions.

merci d'avance

ciao

Lien vers le commentaire
Partager sur d’autres sites

il y a aussi cppdoc (www.cppdoc.com) qui existe sous Linux et windows.

Il est très intéressant car il reconnait les memes tags de commentaires que Javadoc.

Et comme Javadoc il génère aussi la doc sur les hiérarchies et les relations entre les classes.

Lien vers le commentaire
Partager sur d’autres sites

  • 4 semaines après...

Archivé

Ce sujet est désormais archivé et ne peut plus recevoir de nouvelles réponses.

×
×
  • Créer...