Che cosa posso utilizzare per generare documentazione API con la mia formattazione personalizzata?

3

Voglio generare automaticamente la documentazione per un progetto java, ma mi piacerebbe avere il mio stile personalizzato per questo.

Ad esempio, prendi la stackoverflow api (pagina descrizione del metodo) , che può essere fatta da uno strumento automatizzato? Può "portarmi vicino" a quello?
Non mi dispiacerebbe dover cambiare manualmente alcune cose per ottenere il risultato che voglio (cioè: non deve essere automatizzato al 100%)

    
posta juan 08.07.2011 - 21:34
fonte

2 risposte

3

Doxygen e NaturalDocs sono entrambe alternative personalizzabili a Javadoc. Javadoc può anche essere personalizzato, come descritto qui: link

... anche se ti avverto, non l'ho mai provato da solo, l'ho trovato solo tramite la ricerca web per "javadoc personalizzare l'output".

    
risposta data 08.07.2011 - 22:13
fonte
1

Come note di Frustrated, un Doclet ti consente di personalizzare i meccanismi Javadoc esistenti. Fare "Javadoc con una svolta" probabilmente ha anche alcuni vantaggi in termini di integrazione IDE.

In particolare, dato l'uso del markdown sui siti di stackexchange, potresti voler vedere questo che gestisce il markdown , che potrebbe essere un codice utile da guardare anche se non sono le regole di formattazione desiderate.

    
risposta data 09.07.2011 - 02:27
fonte

Leggi altre domande sui tag