Comment créer une documentation Java par ordre d'apparition?

Question

J'ai un très gros fichier de classe .java qui a beaucoup de membres. Comment puis-je créer une documentation HTML pour cela, de sorte qu'il me montre les membres par ordre d'apparition, sans trier par type de membre? (méthodes, constantes et variables)

Par exemple, si mon code Java est:

private int typeOfAction_1;  // notice the order: 1,2,3.. 
public void startAction_2(){ 
} 

private int jobtype_3; 
private int jobcount_4; 
private void doJob_5(){ 
} 

public void haltAction_6(){ 
} 

commandes Javadoc membres dans l'ordre alphabétique et triés par type, et par conséquent, les relations entre les membres sont perdus:

int jobcount_4;  // notice how the order is lost: 4,3,1.. 
int jobtype_3; 
int typeOfAction_1; 

doJob_5() 
haltAction_6() 
startAction_2() 

De même, la documentation génère-t-elle des fonctionnalités plus intelligentes? comme:

1. Extraction des commentaires à proximité des méthodes & variables
2. Taille des méthodes - lignes de code

Answer 1

doclet norme de Javadoc ne supporte pas l'ordre d'affichage personnalisé pour les méthodes. Si vous avez besoin de cette fonctionnalité, vous devrez développer un document personnalisé (ou en trouver un qui répondra à vos besoins).

Il existe un certain nombre de générateurs de documents autres que Javadoc qui peuvent gérer Java. Doxygen et ROBODoc sont deux de ces outils. Je crois que ces deux outils fournissent l'option pour que les éléments (par exemple les méthodes) apparaissent dans le même ordre dans la documentation générée qu'ils apparaissent dans le code source.

Answer 2

Une autre approche possible serait tout simplement de prendre en compte les membres qui appartiennent ensemble dans une classe ou des classes séparées, si elles sont vraiment séparés sur le plan conceptuel des autres membres de la classe ...