javadoc

Voir le sujet précédent Voir le sujet suivant Aller en bas

javadoc

Message  captaing le Mar 23 Mar 2010, 22:25

Bonsoir, j'ai un problème quand je génère ma javadoc, toutes mes méthodes n'apparaissent pas dans mon "API".
Elles ne sont pas là pourtant je les ai documentés.
Je ne sais pas s'il y a un rapport avec le fait que j'ai des warnings lorsque je lance la commande pour la javadoc!!

captaing

Nombre de messages : 26
Prénom : stevie
Date d'inscription : 16/10/2008

Revenir en haut Aller en bas

Re: javadoc

Message  pbt le Mar 23 Mar 2010, 22:28

Tu parles bien de toutes tes méthodes publiques ? Si oui que disent les warnings ?



_________________
smartq.namok.be · faq ·  · IRC / irc.freenode.net #esi · blog.namok.be
style #pbt {heigth:189cm; weight:79kg; eye-color:#524000; hair:very short; dead pixels: some; }

pbt
Admin

Nombre de messages : 4862
Age : 45
Prénom : Pierre
Statut : prof
Localisation : La cité des géants
Date d'inscription : 24/11/2005

http://esi.namok.be

Revenir en haut Aller en bas

Re: javadoc

Message  captaing le Mar 23 Mar 2010, 22:53

pour les warnings, je viens de les corriger. C'était surtout lorsque j'avais plusieurs param je les séparait par une virgule mais maintenant je fais un @param pour chacun d'entre eux.
Donc mes méthodes qui ne sont pas public n'apparaissent pas dans mon "API" même celle a visibilitée package?

captaing

Nombre de messages : 26
Prénom : stevie
Date d'inscription : 16/10/2008

Revenir en haut Aller en bas

Re: javadoc

Message  pbt le Mer 24 Mar 2010, 08:28

captaing a écrit:Donc mes méthodes qui ne sont pas public n'apparaissent pas dans mon "API" même celle a visibilitée package?

Si je lis ma page de manuel, je vois ceci
The Javadoc tool parses the declarations and documentation comments in a set of Java source files and produces a corresponding set of HTML pages describing (by default) the public and protected classes, nested classes (but not anonymous inner classes), interfaces, constructors, methods, and fields. You can use it to generate the API (Application Programming Interface) documentation or the implementation documentation for a set of source files.

_________________
smartq.namok.be · faq ·  · IRC / irc.freenode.net #esi · blog.namok.be
style #pbt {heigth:189cm; weight:79kg; eye-color:#524000; hair:very short; dead pixels: some; }

pbt
Admin

Nombre de messages : 4862
Age : 45
Prénom : Pierre
Statut : prof
Localisation : La cité des géants
Date d'inscription : 24/11/2005

http://esi.namok.be

Revenir en haut Aller en bas

Re: javadoc

Message  Anthoblack le Mer 24 Mar 2010, 15:28

Je complèterais la réponse de M. Bettens par une question :

En quoi cela te semble intéressant de fournir à celui qui va utiliser ta classe une documentation sur des méthodes privées dont il n'aura, donc, aucun accès ?
La javadoc est donc logique de ne pas mettre tes méthodes privées...

Anthoblack

Nombre de messages : 764
Age : 28
Prénom : Anthony
Statut : Ex-étudiant
Localisation : Bruxelles
Date d'inscription : 11/03/2008

Revenir en haut Aller en bas

Re: javadoc

Message  DjMan42 le Lun 19 Avr 2010, 13:28

Faut-il aussi générer de la javadoc pour les classes abstraites comme coup ? J'ai lu quelque part sur le forum qu'on ne fournissait de la javadoc que pour les méthodes non privées. Merci de bien vouloir m'aider.

DjMan42

Nombre de messages : 219
Prénom : Eden
Statut : Etudiant 1er Indu
Localisation : Bruxelles
Date d'inscription : 28/10/2008

Revenir en haut Aller en bas

Re: javadoc

Message  mcd le Lun 19 Avr 2010, 14:21

abstrait/concret et public/non public sont deux choses différentes.
Si une méthode est abstraite, ceux qui vont en faire une version concrète doivent savoir comment elle est censée fonctionner -> la javadoc a tout son intérêt Smile

mcd

Nombre de messages : 1548
Prénom : Marco
Statut : prof
Localisation : Molenbeek
Date d'inscription : 29/09/2006

http://mcd.namok.be

Revenir en haut Aller en bas

Re: javadoc

Message  DjMan42 le Lun 19 Avr 2010, 14:42

mcd a écrit:abstrait/concret et public/non public sont deux choses différentes.
Si une méthode est abstraite, ceux qui vont en faire une version concrète doivent savoir comment elle est censée fonctionner -> la javadoc a tout son intérêt Smile

Merci, pour l'éclaircissement. Very Happy

DjMan42

Nombre de messages : 219
Prénom : Eden
Statut : Etudiant 1er Indu
Localisation : Bruxelles
Date d'inscription : 28/10/2008

Revenir en haut Aller en bas

Re: javadoc

Message  mba le Lun 19 Avr 2010, 20:39

j'ajouterais que pour ce projet (exceptionnellement) j'aimerais voir la javadoc des méthodes avec visibilité package, c'est à dire la majorité des méthodes que vous avez écrit ;-)

mba

Nombre de messages : 1493
Statut : prof
Localisation : Lessines
Date d'inscription : 07/10/2006

Revenir en haut Aller en bas

Re: javadoc

Message  DjMan42 le Lun 19 Avr 2010, 21:30

Merci, c'est encore plus clair. Very Happy

DjMan42

Nombre de messages : 219
Prénom : Eden
Statut : Etudiant 1er Indu
Localisation : Bruxelles
Date d'inscription : 28/10/2008

Revenir en haut Aller en bas

Re: javadoc

Message  nvs le Lun 19 Avr 2010, 21:50

mba a écrit:j'ajouterais que pour ce projet (exceptionnellement) j'aimerais voir la javadoc des méthodes avec visibilité package, c'est à dire la majorité des méthodes que vous avez écrit ;-)
pourquoi exceptionnellement ?

les méthodes publiques, protégées et de paquetage ne doivent-elles pas d'office être documentées ? elles peuvent toutes être utilisées par un codeur tiers qui utiliserait la bibliothèque en question, donc pas le choix à mon avis. les attributs privés, par contre, c'est de la cuisine interne, donc pas de javadoc... mais des commentaires pour l'éventuel codeur qui devra, non pas utiliser la bibliothèque, mais recoder la bibliothèque Smile

ça peut sûrement se discuter...







What a Face

_________________

nvs

Nombre de messages : 5238
Age : 44
Prénom : Nicolas
Statut : prof
Localisation : bxl
Date d'inscription : 24/11/2005

http://nvansteenkiste.googlepages.com

Revenir en haut Aller en bas

Re: javadoc

Message  mba le Mar 20 Avr 2010, 06:38

nvs a écrit:pourquoi exceptionnellement ?

c'est vrai que tout peut être discuté, le cas du recodage n'est pas vraiment pris en compte :-)

le programmeur d'une vue de ce jeu de dames doit uniquement utiliser ce qui est public dans le package dames et non ce qui est package, les méthodes package sont "propres au moteur". C'est notre choix.

De plus l'outil javadoc ne montre pas par défaut ce qui a une visibilité package.

Ma requête n'a donc de sens que dans un cadre pédagogique.

mba

Nombre de messages : 1493
Statut : prof
Localisation : Lessines
Date d'inscription : 07/10/2006

Revenir en haut Aller en bas

Re: javadoc

Message  nvs le Mar 20 Avr 2010, 12:55

mba a écrit:
nvs a écrit:pourquoi exceptionnellement ?

c'est vrai que tout peut être discuté, le cas du recodage n'est pas vraiment pris en compte :-)

le programmeur d'une vue de ce jeu de dames doit uniquement utiliser ce qui est public dans le package dames et non ce qui est package, les méthodes package sont "propres au moteur". C'est notre choix.
il me semble que rien ne m'empêche de prendre ta bibliothèque et d'utiliser les méthodes du paquetage. il me suffit de me mettre dans ton paquetage. quel que soit votre choix Wink et puis, avez-vous empêché la dérivation de vos classes ? si non, rien ne m'empêche, à nouveau d'utiliser ces méthodes... et les méthodes protégées...

les seules méthodes qui sont réellement cachées, ce sont les méthodes privées. le masquage de l'implémentation et de la cuisine interne est plus sécurisé par le recours aux classes internes privées...

ceci dit, il existe peut-être une convention tacite en java qui consiste à ne jamais travailler dans le paquetage d'une bibliothèque qu'on utilise et à ne jamais tenter d'utiliser les méthodes d'accès package ?

je ne suis pas sûr que cette discussion soit bien à sa place ici, mais c'est un problème majeur et récurent... sauf en assembleur Very Happy








pirat

_________________

nvs

Nombre de messages : 5238
Age : 44
Prénom : Nicolas
Statut : prof
Localisation : bxl
Date d'inscription : 24/11/2005

http://nvansteenkiste.googlepages.com

Revenir en haut Aller en bas

Re: javadoc

Message  mba le Mar 20 Avr 2010, 13:23

nvs a écrit:il me semble que rien ne m'empêche de prendre ta bibliothèque et d'utiliser les méthodes du paquetage
nous sommes bien d'accord. :-)

mba

Nombre de messages : 1493
Statut : prof
Localisation : Lessines
Date d'inscription : 07/10/2006

Revenir en haut Aller en bas

Re: javadoc

Message  Contenu sponsorisé Aujourd'hui à 10:52


Contenu sponsorisé


Revenir en haut Aller en bas

Voir le sujet précédent Voir le sujet suivant Revenir en haut


 
Permission de ce forum:
Vous ne pouvez pas répondre aux sujets dans ce forum