Condividi tramite

Commenti nel codice (Visual Basic)

Durante la lettura degli esempi di codice, spesso viene visualizzato il simbolo di commento ('). Questo simbolo indica al compilatore di Visual Basic di ignorare il testo che lo segue o il commento. I commenti sono brevi note esplicative aggiunte al codice per il vantaggio di chi la legge.

È buona norma di programmazione iniziare tutte le procedure con un breve commento che descrive le caratteristiche funzionali della procedura (che cosa fa). Questo è per il proprio vantaggio e il vantaggio di chiunque altro che esamina il codice. È consigliabile separare i dettagli di implementazione (come la procedura esegue) dai commenti che descrivono le caratteristiche funzionali. Quando si includono i dettagli di implementazione nella descrizione, ricordarsi di aggiornarli quando si aggiorna la funzione.

I commenti possono seguire un'istruzione sulla stessa riga o occupare un'intera riga. Entrambi sono illustrati nel codice seguente.

' 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ù righe, usare il simbolo di commento su ogni riga, come 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.

Linee guida per i commenti

La tabella seguente fornisce linee guida generali per i tipi di commenti che possono precedere una sezione di codice. Questi sono suggerimenti; Visual Basic non applica regole per l'aggiunta di commenti. Scrivere ciò che funziona meglio, sia per l'utente che per chiunque altro che legge il codice.

Tipo di commento Descrizione del commento
Scopo Descrive le operazioni della procedura (non come funziona)
Presupposti Elenca ogni variabile esterna, controllo, file aperto o altro elemento a cui si accede tramite la procedura
Effetti Elenca ogni variabile esterna, controllo o file interessato e l'effetto che ha (solo se non è ovvio)
Ingressi dati Specifica lo scopo dell'argomento
Restituzioni Illustra i valori restituiti dalla procedura

Tenere presente quanto segue:

  • Ogni dichiarazione di variabile importante deve essere preceduta da un commento che descrive l'uso della variabile dichiarata.

  • Le variabili, i controlli e le procedure devono essere denominate in modo chiaro che il commento è necessario solo per i dettagli di implementazione complessi.

  • I commenti non possono seguire una sequenza di continuazione sulla stessa riga.

È possibile aggiungere o rimuovere simboli di commento per un blocco di codice selezionando una o più righe di codice e scegliendo il commento (pulsante Commento di Visual Basic in Visual Studio).) e Rimuovi commento (pulsante Rimuovi commento di Visual Basic in Visual Studio).) sulla barra degli strumenti Modifica .

Annotazioni

È anche possibile aggiungere commenti al codice precedendo il testo con la REM parola chiave . Tuttavia, il ' simbolo e i pulsanti Comment/Uncomment sono più facili da usare e richiedono meno spazio e memoria.

Vedere anche