Posso usare GhostDoc per aggiungere la documentazione per un intero file di classe o il codice?

Question

Amo GhostDoc, ma voglio essere in grado di "documento Questo" per un intero file, e non solo un membro alla volta. È possibile?

Answer 1

No. Amo ancora anche indipendentemente.

Answer 2

Quando ho inizialmente risposto a questa domanda, questo non era possibile in GhostDoc, o nel mio (simile) componente aggiuntivo, Atomineer Pro Documentazione ).

(Questa è stata una scelta di design intenzionale Atomineer, e presumibilmente anche in GhostDoc, perché è una generalmente cattiva idea di documentare automaticamente tutto e andare avanti. Entrambi questi componenti aggiuntivi produrre un punto di partenza ragionevole per la documentazione di un metodo, e qualche volta forniranno una buona documentazione sufficiente che non è necessario effettuare alcuna regolazione - ma la maggior parte del tempo si vorranno modificare il commento risultante Se si auto-generare l'intero set di documentazione, quindi la documentazione sarà piuttosto scarsa. , perché essi non fanno altro che descrivere ciò che i nomi degli elementi di codice già stato).

Tuttavia , entrambi addins ora ora forniscono questa caratteristica, che è molto utile nelle seguenti situazioni:

• (in Atomineer) Per commenti legacy batch conversione tra JavaDoc, Doxygen, Qt e documentazione XML formati
• (in Atomineer) Per aggiornare lo stile / layout commenti di documentazione dopo aver modificato le opzioni di formattazione AtomineerUtils
• (in entrambi i componenti aggiuntivi) Per aggiungere rapidamente la documentazione scheletro ad una classe

In tutte queste situazioni si raccomanda vivamente di leggere le osservazioni risultanti, ma automatizzando l'aggiornamento non risparmiare un sacco di tempo.

Answer 3

Opzione Usa documento del file:

Scegliere Documento File Option

vedere il commento aggiunto per tutti i membri all'interno del file