Documentation objets java

**yoda_81fr** · 15/04/2008, 17h56

bonjour à tous,

Je voudrais faire quelque chose d'assez simple mais après plein d'essais je ne vois pas comment le faire rapidement et simplement.
J'ai mes sources java et je veux juste fournir le nom de l'objet (Package+nom) et les attributs de l'objet (avec le type)

Est ce possible?

Please

Merci d'avance

**natha** · 15/04/2008, 21h53

Rien compris... Tu peux aller lire le lien dans ma signature pour bien poser une question !

**yoda_81fr** · 16/04/2008, 08h59

Alors je vais réexpliquer plus clairement.
Je créé des objets java (beans, jdo...) et des méthodes de manipulations pour les utiliser (par exemple mettre à jour un objet, création de lien entre eux automatique) ou des fichiers de configuraitons.
Ces méthodes sont à disposition de mes collègues mais ils n'ont pas accès aux objets. Donc le but c'était de faire une documentation qui me donne pour chaque objets que je créé la liste de ses attributs (genre name, displayName....)
Je voulais savoir si c'était possible de générer ce genre de documentation automatiquement via les sources java

Est ce que c'est plus clair comme ça?

**natha** · 16/04/2008, 09h32

Euh, tu veux faire une javadoc en fait.
Fait des recherches sur le sujet, c'est pas compliqué

**yoda_81fr** · 16/04/2008, 09h39

Pas vraiment car la javadoc me donne pas la liste des attributs d'une classe java... si?

**natha** · 16/04/2008, 09h56

Envoyé par yoda_81fr

Pas vraiment car la javadoc me donne pas la liste des attributs d'une classe java... si?

Tu peux les mettre dans ta javadoc de la classe. Tu mets ce que tu veux.

**yoda_81fr** · 16/04/2008, 10h17

Certes mais je ne veux modifier les objets que j'ai déjà créé... :s

**natha** · 16/04/2008, 10h23

Envoyé par yoda_81fr

Certes mais je ne veux modifier les objets que j'ai déjà créé... :s

Tu ne modifies pas l'objet, tu ajoutes de la javadoc.
Ca modifie le source certe, mais c'est la façon la plus fiable de procéder car ça permet également une autocomplétion claire dans les IDE lors de l'utilisation de ces objets.

Je ne connais pas de solution de génération automatique de doc Java qui ne se base pas sur la javadoc.

**yoda_81fr** · 16/04/2008, 10h41

Il y a une balise particulière (genre @tags) ou tu mettrais les noms des attributs en dur?

Documentation objets java

Eclipse Java

Discussions similaires

Partager

Partager