Domanda

Quando sto sviluppando in C #, ho pesantemente uso GhostDoc per accelerare il processo di commentare il mio codice. Attualmente sto lavorando su un progetto C ++ e non ho trovato uno strumento equivalente. So di Doxygen, ma da quello che so è usato per creare la documentazione di fuori del codice, senza commenti nel codice. Ci sono strumenti buoni equivalenti? Io preferirei uno che corre in VS, ma ho potuto gestire uno che funziona in qualsiasi IDE.

(Prima che qualcuno lo porta su, non fare affidamento esclusivamente su GhostDoc per creare commenti. Ho solo lo uso per creare il punto di partenza per i miei commenti.)

È stato utile?

Soluzione

visiva Assist aiuta fornendo script personalizzati eseguiti durante la digitazione (o su altri).

Per esempio, si può avere uno script per i commenti come questo:

/************************************************************************/
/* My comment : $end$                                                                     */
/************************************************************************/

Questo sarebbe suggerito (tramite una combo-box esattamente come IntelliSense), quando si inizia a digitare "/ **", per esempio. Quando si seleziona questo suggerimento (tramite Invio / Spazio / Click - personalizzabile), si inserisce lo script in cui si trova il cursore e basta sostituire i marcatori che sono tra i caratteri '$' di valori speciali (come il nome del file corrente, ad esempio). Qui il $ marcatore $ fine farà il cursore sia in questa posizione quando viene eseguito lo script. In questo modo, continuare a digitare senza problemi. Ad esempio con il precedente set di script, digitando esattamente:

/** this is a test comment to show you one of the many features Visual Assit!

si limiterà a dare:

/************************************************************************/
/* My comment : this is a test comment to show you one of the many features Visual Assit!                                                                     */
/************************************************************************/

E 'davvero facile da personalizzare e il comportamento della suggestione (leggi: intellisense ++). Sistema è personalizzabile

Altri suggerimenti

Ho scritto un add-in, Atomineer Pro Documentazione , che è molto simile a GhostDoc (che genera commenti di documentazione / aggiornamenti per risparmiare un sacco di tempo e fatica per la documentazione), ma analizza il codice direttamente per se stesso e, quindi, è in grado di gestire C, C ++, C ++ / CLI, C #, Java e il codice Visual Basic, e non richiede il codice circostante di essere in uno stato di compilazione prima che funziona. Sarà anche aggiungere automaticamente / documentazione di aggiornamento per le cose più difficili, come eccezioni generate all'interno del corpo di un metodo.

Il programma funziona in Visual Studio 11, 2010, 2008 e 2005 e supporta Documentazione-Xml, Doxygen, JavaDoc e Qt formati commentando, così come il formato / stile di blocchi di commento e le regole di auto-doc utilizzate essere altamente configurabile . Ha un certo numero di altre funzioni utili, come aiutare le conversioni di legacy-doc commenti ai formati di cui sopra, e il ritorno a capo nel doc-commenti e le normali commenti a blocchi.

Quanto sopra è solo un riassunto di alcune delle principali caratteristiche - Questo confronto delle caratteristiche con altri prodotti serve come un elenco più completo delle molte altre funzioni disponibili.

visiva Assist potrebbe fare il lavoro, anche se non sono assolutamente sicuro.

Autorizzato sotto: CC-BY-SA insieme a attribuzione
Non affiliato a StackOverflow
scroll top