Equivalente GhostDoc per Eclipse (Java)

Question

Sono un grande fan di GhostDoc s ' generazione automatica commento in Visual Studio lo sono alla ricerca di un plugin che fa lo stesso lavoro con il mio codice Java in Eclipse. Tutti i consigli?

Answer 1

E 'fondamentalmente l'equivalente di Javadoc, che può essere generando in Eclipse con collegamento:

ALT + Maiusc + J

(quando ci si trova all'interno della funzione Java che si desidera aggiungere javadoc per)

Da lì, se si vuole veramente formato XML, si può provare e utilizzare un JELDoclet

Answer 2

È possibile controllare JAutodoc ( http://jautodoc.sourceforge.net/ )
Da parte dell'autore:

  

JAutodoc è un plugin Eclipse per   aggiungendo automaticamente Javadoc e il file   intestazioni al codice sorgente. esso   genera facoltativamente commenti iniziali   dal nome di un elemento utilizzando Velocity   modelli per Javadoc e il file   intestazioni.

Questo è quello che ho trovato più vicino alla GhostDoc.

Answer 3

GhostDoc ha una bella caratteristica in più che deduce una descrizione di ciò che il metodo non analizzando il nome del metodo e di fornire questa documentazione come scheletrico. Ad esempio, utilizzando GhostDoc su un metodo denominato GetDocumentName () potrebbe restituire la frase "Ottiene il nome del documento". Mentre questo è poco più informazioni di quanto previsto dal nome del metodo, si aggiunge il metodo di documentazione dove prima non esisteva. Qualcuno potrebbe obiettare che questo è appena utile. Io sostengo il contrario perché supporta la documentazione di generazione dal codice sorgente (ad esempio, per strumenti come NDoc o SandCastle).

A mio parere il più grande vantaggio di GhostDoc sopra di Eclipse "Generate Elemento Commento" è che incoraggia i programmatori per iniziare ad aggiungere commenti di documentazione con l'aggiunta di un modo estremamente veloce e affidabile creare questo. Il programmatore può accettare il testo dedotto, (adatto a 50 - 80% dei casi), o espandere su questo per metodi più complessi. Per il programmatore junior, che non è così a conoscenza di come vengono utilizzati i commenti di documentazione, questo può ridurre rapidamente la curva di apprendimento e favorire le buone pratiche di programmazione.

Answer 4

Javadoc non è come GhostDoc mio amico. Javadoc crea solo la struttura in modo si può scrivere la documentazione da zero. GhostDoc riempie in realtà il backup delle informazioni secondo il metodo / proprietà nome.

Esempio:

/// <summary>
/// Gets the user from id.
/// </summary>
/// <param name="id">The id.</param>
/// <returns></returns>
private string GetUserFromId(string id);

JAutoDoc è il più vicino che ho trovato finora, ma non è così magico come GhostDoc.

Answer 5

Mai usato GhostDoc, quindi non so cosa funzionalità extra dà, ma se si tratta di generazione di tipologia e per metodi commenti in base al nome, i parametri, tipo di ritorno ecc allora eclissi ha integrato, in modo che nessun estensioni necessarie.