Commenti nel codice (Visual Basic)Comments in Code (Visual Basic)

Negli esempi di codice viene spesso utilizzato il simbolo di commento (').As you read the code examples, you often encounter the comment symbol ('). Questo simbolo indica al compilatore Visual Basic di ignorare il testo che lo segue o il Commento.This symbol tells the Visual Basic compiler to ignore the text following it, or the comment. I commenti sono brevi annotazioni descrittive che vengono aggiunte al codice per agevolarne la lettura.Comments are brief explanatory notes added to code for the benefit of those reading it.

È buona norma di programmazione iniziare tutte le routine con un breve commento che ne descriva le caratteristiche funzionali, ovvero le operazioni che vengono compiute.It is good programming practice to begin all procedures with a brief comment describing the functional characteristics of the procedure (what it does). Ciò può rivelarsi a proprio vantaggio e di chi esaminerà il codice.This is for your own benefit and the benefit of anyone else who examines the code. È opportuno separare le informazioni dettagliate relative alle modalità di implementazione dai commenti che descrivono le caratteristiche funzionali.You should separate the implementation details (how the procedure does it) from comments that describe the functional characteristics. Quando si includono informazioni dettagliate sulle modalità di implementazione, è importante che queste vengano aggiornate contestualmente all'aggiornamento della funzione.When you include implementation details in the description, remember to update them when you update the function.

I commenti possono seguire un'istruzione sulla stessa riga oppure occupare una riga intera.Comments can follow a statement on the same line, or occupy an entire line. Nell'esempio di codice seguente vengono illustrate entrambe le opzioni.Both are illustrated in the following code.

' 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:If your comment requires more than one line, use the comment symbol on each line, as the following example illustrates.

' 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 commentiCommenting Guidelines

Nella tabella riportata di seguito vengono fornite indicazioni generali sui tipi di commenti che possono precedere una sezione del codice.The following table provides general guidelines for what types of comments can precede a section of code. Si tratta di suggerimenti; Visual Basic non impone regole per l'aggiunta di commenti.These are suggestions; Visual Basic does not enforce rules for adding comments. Scrivere il testo che si ritiene più adatto alle proprie esigenze e a quelle di chi leggerà il codice.Write what works best, both for you and for anyone else who reads your code.

Tipo di commentoComment type Descrizione del commentoComment description
ScopoPurpose Descrive le operazioni eseguite dalla routine, non la modalità di esecuzioneDescribes what the procedure does (not how it does it)
PresuppostiAssumptions Elenca tutte le variabili esterne, i controlli, i file aperti o gli altri elementi a cui accede la routineLists each external variable, control, open file, or other element accessed by the procedure
EffettiEffects Elenca tutte le variabili esterne, i controlli o i file interessati, nonché l'effetto su di essi (solo se non è ovvio)Lists each affected external variable, control, or file, and the effect it has (only if it is not obvious)
InputInputs Specifica lo scopo dell'argomentoSpecifies the purpose of the argument
Valori di codice restituitiReturns Spiega i valori restituiti dalla routineExplains the values returned by the procedure

È importante tenere presente i seguenti punti:Remember the following points:

  • Le dichiarazioni di variabili importanti devono essere precedute da un commento in cui viene descritto l'utilizzo della variabile dichiarata.Every important variable declaration should be preceded by a comment describing the use of the variable being declared.

  • 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.Variables, controls, and procedures should be named clearly enough that commenting is needed only for complex implementation details.

  • Non è possibile inserire sulla stessa riga una sequenza di continuazione di riga seguita da un commento.Comments cannot follow a line-continuation sequence on the same line.

È possibile aggiungere o rimuovere i simboli di commento per un blocco di codice selezionando una o più righe di codice e scegliendo il Commento (il Visual Basic pulsante di commento in Visual Studio)e rimuovere il Commento (l'oggetto visivo). Pulsante Rimuovi commento di base in Visual Studio. ) sulla barra degli strumenti modifica. You can add or remove comment symbols for a block of code by selecting one or more lines of code and choosing the Comment (The Visual Basic Comment button in Visual Studio.) and Uncomment (The Visual Basic Uncomment button in Visual Studio.) buttons on the Edit toolbar.

Nota

Per aggiungere commenti al codice è possibile anche inserire la parola chiave REM prima del testo.You can also add comments to your code by preceding the text with the REM keyword. Tuttavia, i ' pulsanti simbolo e Rimuovi/Commento sono più semplici da utilizzare e richiedono meno spazio e memoria.However, the ' symbol and the Comment/Uncomment buttons are easier to use and require less space and memory.

Vedere ancheSee also