C'è una sostituzione javadoc che utilizza una sintassi simile a Wiki?

Question

C'è uno strumento che sostituisce javadoc con qualcosa che è più sintassi in stile Wiki invece della sintassi HTMLish del normale JavaDoc?

Uno dei miei problemi è che ho letto principalmente JavaDoc in formato sorgente. Anche per le librerie esterne provo ad avere la fonte collegata in modo da potervi accedere dal mio IDE, controllando la documentazione sopra il punto di ingresso e, se necessario, il codice sottostante.

L'altro problema è che cose come elenchi e esempi di codice sono disordinati da scrivere, specialmente se il tuo IDE insiste a mettere le stelle su ogni linea. Quello che mi piacerebbe vedere è qualcosa che utilizza una sorta di sintassi Wiki almeno con le seguenti caratteristiche:

• liste
• blocchi di codice
• reticolazione a metodi/classi

ci sono molte altre cose che sarebbero belle, ma credo che queste siano le cose essenziali.

Qualcuno sa di tale strumento?

Answer 1

C'è un progetto chiamato WikiDoclet, non l'ho mai usato, ma sarei interessato a vedere cosa ne pensi.

Dal sito:

Si tratta di un'estensione per il doclet javadoc standard fornito con il Java JDK. Aggiunge il supporto per ciò che sto chiamando la formattazione Wiki. Ciò significa che il tuo JavaDoc può ora essere formattato utilizzando regole di testo più semplici per gli occhi rispetto a html incorporato in JavaDoc. Ad esempio, per mettere l'accento su un pezzo di testo lo si circonda con stelle. Corsivo con caratteri di sottolineatura. Quando il doclet viene eseguito per produrre JavaDoc, queste regole vengono valutate e vengono apportate sostituzioni HTML. Questa formattazione dovrebbe rendere la lettura del codice sorgente java molto più semplice poiché non sarà più ingombra di tag HTML. Questo è particolarmente vero per gli elenchi puntati e per le tabelle. L'HTML è comunque conservato, quindi puoi combinarlo come preferisci.

Per altri formati doclet, vedere doclet.com.

Answer 2

ora qui: http://code.google.com/p/wikidoclet/