2011-01-13 6 views

Répondre

6

Javadoc génération (écrire les fichiers .html) est fait pour vous sur demande (Outils-> Générer Javadoc) et est essentiellement automatique une fois que vous le configurer. Générer javadoc stubs, qui est ce que fait jautodoc pour Eclipse, est fait méthode par méthode, class-by-class et seulement là où vous le dites.

En tapant /** <enter> au-dessus d'une signature de méthode va créer des talons Javadoc pour vous. Je suppose que vous voulez quelque chose qui le fera pour un fichier entier, un paquet ou un projet (comme jautodoc). Il y avait un tel plugin: http://plugins.intellij.net/plugin/?id=952 mais ça ne marchera pas avec 10.

Je dois dire que cet exemple de jautodoc, bien qu'un truc de fête, est la chose la plus inutile que j'ai jamais vue un IDE: Il crée une description basée sur le nom de la variable - mais seulement si le nom de la variable est si descriptif qu'il n'a pas besoin d'un commentaire en premier lieu.

/** 
* The number of questions 
*/ 
private int numberOfQuestions; 

Vous donne envie de carte perforée.

+5

Certains systèmes de construction utilisent checkstyle, jalopy, etc. Ils finissent par demander aux utilisateurs d'ajouter les javadocs boiteux. La meilleure pratique consiste à faire en sorte que votre code parle de lui-même, mais lorsque vous êtes bloqué en train de créer des données à cause de votre politique d'entreprise qui l'exige, les fonctions similaires à jautodoc sont agréables. ctrl alt j et vous êtes bon à commettre. – branchgabriel

Questions connexes