Commenti nel codice (Visual Basic)

Negli esempi di codice viene spesso utilizzato il simbolo di commento ('). Questo simbolo indica al compilatore Visual Basic di ignorare il testo seguente, ovvero il commento. I commenti sono brevi annotazioni descrittive che vengono aggiunte al codice per agevolarne la lettura.

È buona norma di programmazione iniziare tutte le routine con un breve commento che ne descriva le caratteristiche funzionali, ovvero le operazioni che vengono compiute. Ciò può rivelarsi a proprio vantaggio e di chi esaminerà il codice. È opportuno separare le informazioni dettagliate relative alle modalità di implementazione dai commenti che descrivono le caratteristiche funzionali. Quando si includono informazioni dettagliate sulle modalità di implementazione, è importante che queste vengano aggiornate contestualmente all'aggiornamento della funzione.

I commenti possono seguire un'istruzione sulla stessa riga oppure occupare una riga intera. Nell'esempio di codice seguente vengono illustrate entrambe le opzioni.

' This is a comment beginning at the left edge of the screen.
text1.Text = "Hi!"   ' This is an inline comment.

Se il commento richiede più di una riga, utilizzare il simbolo di commento su ogni riga, così come viene illustrato nell'esempio seguente:

' This comment is too long to fit on a single line, so we break  
' it into two lines. Some comments might need three or more lines.

Indicazioni sui commenti

Nella tabella riportata di seguito vengono fornite indicazioni generali sui tipi di commenti che possono precedere una sezione del codice. Si tratta di semplici suggerimenti; Visual Basic non impone alcuna regola per l'aggiunta di commenti. Scrivere il testo che si ritiene più adatto alle proprie esigenze e a quelle di chi leggerà il codice.

Tipo di commento	Descrizione del commento
Scopo	Descrive le operazioni eseguite dalla routine, non la modalità di esecuzione
Presupposti	Elenca tutte le variabili esterne, i controlli, i file aperti o gli altri elementi a cui accede la routine
Effetti	Elenca tutte le variabili esterne, i controlli o i file interessati, nonché l'effetto su di essi (solo se non è ovvio)
Input	Specifica lo scopo dell'argomento
Valore restituito	Spiega i valori restituiti dalla routine

È importante tenere presente i seguenti punti:

• Le dichiarazioni di variabili importanti devono essere precedute da un commento in cui viene descritto l'utilizzo della variabile dichiarata.

• I nomi di variabili, controlli e routine devono essere descrittivi in modo da rendere necessaria l'aggiunta di commenti solo per la descrizione di implementazioni complesse.

• Non è possibile inserire sulla stessa riga una sequenza di continuazione di riga seguita da un commento.

Per aggiungere o rimuovere i simboli di commento per un blocco di codice, selezionare una o più righe di codice e fare clic sui pulsanti Commento () e Rimuovi commento () sulla barra degli strumenti Modifica.

Nota

Per aggiungere commenti al codice è possibile anche inserire la parola chiave REM prima del testo.Il simbolo ' e i pulsanti Commento/Rimuovi commento sono comunque più semplici da utilizzare e richiedono meno spazio e memoria.

Vedere anche

Attività

Procedura: creare documentazione XLM in Visual Basic

Riferimenti

Tag XML consigliati per i commenti relativi alla documentazione (Visual Basic)

Istruzione REM (Visual Basic)

Altre risorse

Documentare il codice con commenti XML

Struttura del programma e convenzioni di scrittura del codice (Visual Basic)