Generazione automatica della documentazione delle funzioni in Visual Studio

Question

Mi chiedevo se esiste un modo (si spera scorciatoia da tastiera) per creare intestazioni di funzioni di generazione automatica in Visual Studio.

Esempio:

Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)

E diventerebbe automagicamente qualcosa del genere ...

'---------------------------------- 
'Pre: 
'Post:
'Author: 
'Date: 
'Param1 (String): 
'Param2 (Integer): 
'Summary: 
Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)

Answer 1

Rendi questo " tre singoli marcatori di commento "

In C # è ///

che di default sputa:

/// <summary>
/// 
/// </summary>
/// <returns></returns>

Ecco alcuni suggerimenti sulla modifica dei template VS .

Answer 2

GhostDoc !

Fai clic con il pulsante destro del mouse sulla funzione, seleziona " Documenta questo " e

private bool FindTheFoo(int numberOfFoos)

diventa

/// <summary>
/// Finds the foo.
/// </summary>
/// <param name="numberOfFoos">The number of foos.</param>
/// <returns></returns>
private bool FindTheFoo(int numberOfFoos)

(sì, è tutto generato automaticamente).

Ha il supporto per C #, VB.NET e C / C ++. Per impostazione predefinita è mappato su Ctrl + Maiusc + D .

Ricorda: è necessario aggiungere informazioni oltre la firma del metodo alla documentazione. Non limitarti a smettere con la documentazione generata automaticamente. Il valore di uno strumento come questo è che genera automaticamente la documentazione che può essere estratta dalla firma del metodo, quindi qualsiasi informazione aggiunta dovrebbe essere nuova .

Detto questo, preferisco personalmente quando i metodi sono totalmente autodocumentati, ma a volte avrai standard di codifica che impongono una documentazione esterna, e quindi uno strumento come questo ti farà risparmiare un sacco di digitazione Braindead.

Answer 3

///

è la scorciatoia per ottenere il blocco di commenti Descrizione metodo. Assicurati di aver scritto il nome e la firma della funzione prima di aggiungerlo. Scrivi prima il nome e la firma della funzione.

Quindi sopra il nome della funzione basta digitare ///

e lo otterrai automaticamente

Answer 4

Visual Assist ha anche una bella soluzione ed è altamente costumizzabile.

Dopo averlo modificato per generare commenti in stile doxygen, questi due clic genererebbero -

/**
* Method:    FindTheFoo
* FullName:  FindTheFoo
* Access:    private 
* Qualifier:
* @param    int numberOfFoos
* @return   bool
*/
private bool FindTheFoo(int numberOfFoos)
{

}

(Con le impostazioni predefinite, è un po 'diverso.)

---

Modifica: Il modo per personalizzare il testo del "metodo documento" è in VassistX- > Opzioni di assistenza visiva- > Suggerimenti, seleziona "Modifica frammenti VA", Lingua: C ++, Tipo: refactoring, quindi vai a "Metodo documento" e personalizza. L'esempio sopra è generato da:

Answer 5

Normalmente, Visual Studio lo crea automaticamente se aggiungi tre singoli marcatori di commento sopra l'elemento che desideri commentare (metodo, classe).

In C # questo sarebbe /// .

Se Visual Studio non lo fa, è possibile abilitarlo in

  

Opzioni- > Editor di testo- > C # - > Avanzate

e seleziona

  

Genera commenti sulla documentazione XML per ///

Answer 6

In Visual Basic, se prima crei la tua funzione / sub, poi sulla riga sopra di essa, digiti tre volte, genererà automaticamente l'xml rilevante per la documentazione. Questo appare anche quando passi il mouse su intellisense e quando stai usando la funzione.

Answer 7

È possibile utilizzare frammenti di codice per inserire le righe desiderate.

Inoltre, se si digitano tre virgolette singole ('' ') sulla riga sopra l'intestazione della funzione, verrà inserito il modello di intestazione XML che è possibile compilare.

Questi commenti XML possono essere interpretati dal software di documentazione e sono inclusi nell'output di compilazione come file assembly.xml. Se mantieni quel file XML con la DLL e fai riferimento a quella DLL in un altro progetto, quei commenti diventano disponibili in intellisense.

Answer 8

Sto lavorando a un progetto open source chiamato Todoc che analizza le parole per produrre automaticamente la corretta documentazione durante il salvataggio di un file. Rispetta i commenti esistenti ed è veramente veloce e fluido.

http://todoc.codeplex.com/