Quando si costruisce un'API per un cliente, la javadoc pubblica deve contenere solo ciò che si desidera mostrare al cliente. Il che è un peccato, dato che javadoc è anche, in qualche modo, l'obiettivo ovvio per alcuni tipi di documentazione di progettazione interna. Si potrebbe immaginare un doclet personalizzato o qualche altro trucco per consentire ai due tipi di informazioni di coesistere nella fonte. Qualcuno è stato lì?
È possibile documentare gli interni nei commenti javadoc per private e package private attributi e metodi. Ciò consente di generare 2 versioni di javadoc, una per l'interfaccia pubblica e una che include tutte le informazioni.
Modifica
Senza alcun tipo di pre-elaborazione le tue opzioni sono limitate. Se è necessario aggiungere informazioni interne al livello di classe, è necessario aggiungere un membro privato non utilizzato per appendere il commento di apidoc, ad esempio:
/**
* Internal secrets.
*/
private Object documentation;
O se permetteresti un po 'di pre-elaborazione tramite uno script di formica, puoi fare qualcosa del tipo:
/**
* Public class documentation.
*//*INTERNAL:
* internal additional documentation.
*/
public MyClass {
e usa un'azione di sostituzione da ant:
<replace dir="${source.dir}" includes="**/*.java" summary="yes">
<replacefilter token="*//*INTERNAL:" value="*" />
</replace>
Leggi altre domande sui tag development-process documentation