Chaque classe/objet de Java Documentation fournit une description de cette classe, un résumé de champ, un résumé de constructeur, un résumé de méthode et des détails les concernant. Je ne suis intéressé que par la partie résumé, y a-t-il un moyen de générer un tel Javadoc?Java Résumé de l'API
Ou s'il y a quelque chose comme ça déjà là. Tout va marcher, pdf, chm, n'importe quel format, mais résumé.
Vous devez marquer vos méthodes avec la syntaxe suivante:
/**
* {Put your method description here}
*
* @param {Put your description of your parameter here}
* ...
* @return {Put your description of your return value here}
*/
Ensuite exécuter le Programme javadoc. Vous pouvez le trouver dans le dossier bin du dossier d'installation de jdk
Ce n'est pas la réponse à cette question, il veut une documentation API Java personnalisée. –
Oui, c'est vrai. – reporter
@Prateek: Il est juste nessacary d'omettre les méthodes. Avec javadoc vous pouvez ajouter des descriptions pour les classes, les constructeurs et les méthodes. – reporter
Vous devriez être capable de générer une telle documentation avec un doclet personnalisé. Voir javadoc documentation.
N'y a-t-il pas déjà de la documentation disponible de ce genre? Je suis nouveau à Java, et je ne sais vraiment pas comment créer de la documentation à partir de la source. –
Peut-être que cela aide: http://stackoverflow.com/questions/9008171/print-javadoc-summary-only – HectorLector
@HectorLector - Cette question concerne la documentation personnalisée de Java pour le code développé. Je parle ici de la documentation originale de Java Source ... –