Inserimento di commenti al codice XML

Aggiornamento: novembre 2007

I commenti al codice corrispondono a commenti inseriti nei file di codice sorgente che sono quindi disponibili per gli utenti dell'ambiente di sviluppo integrato (IDE) tramite la funzionalità IntelliSense.

[Visual Basic]

I commenti al codice XML sono disponibili in Visual Basic tramite il delimitatore ''' (tre virgolette singole). Per ulteriori informazioni, vedere Procedura: creare documentazione XLM in Visual Basic.

[C#, J#]

È possibile utilizzare la funzionalità di documentazione XML per commentare il codice. In caso di annotazione di tipi e membri definiti nei file di origine delle soluzioni con commenti della documentazione XML, tali commenti verranno visualizzati tramite le funzionalità IntelliSense, ad esempio:

• Elenca membri

• Informazioni parametri

• Informazioni rapide

Nota:
Quando si aggiungono commenti a metodi parziali, solo i commenti posizionati nell'implementazione, non la definizione, vengono visualizzati nelle funzionalità di IntelliSense.

Per ulteriori informazioni, vedere Commenti relativi alla documentazione XML (Guida per programmatori C#).

[C++]

In base all'impostazione predefinita, ogni commento incluso nel codice sorgente che utilizza i delimitatori // o /* viene visualizzato accanto al membro a cui è associato nell'elenco Membri. Per ulteriori informazioni, vedere C++ Comments e XML Documentation (Visual C++).

Scorrendo l'elenco, IntelliSense visualizzerà fino a 12 righe del commento in una finestra popup accanto al membro evidenziato. Se esiste più di un commento per una funzione, IntelliSense stabilirà quale commento visualizzare nell'elenco Membri, in base al punto in cui il commento appare nel codice:

1. Verranno visualizzati innanzitutto i commenti di fine riga nella dichiarazione. Di seguito è riportato un esempio:

   void MyFunction();   //EOL declaration comments
   

2. Se non viene trovato il tipo di commento precedente, verranno visualizzati i commenti che appaiono immediatamente prima della dichiarazione senza righe vuote frapposte. Di seguito è riportato un esempio:

   //Before declaration comments
      void MyFunction();
   

3. Se i due tipi di commenti precedenti non vengono trovati nel codice, verranno visualizzati i commenti di fine riga nella definizione. Di seguito è riportato un esempio:

   int CMyAppDoc::MyVariable=2; // EOL definition comments
   

4. Se infine nessuno dei tipi di commenti precedenti è incluso nel codice, verranno visualizzati i commenti che appaiono immediatamente prima della dichiarazione senza righe vuote frapposte. Di seguito è riportato un esempio:

   //Before definition comments
   CMyAppDoc::MyFunction() 
   {
      return; 
   }
   

Vedere anche

Riferimenti

Elenca membri

Altre risorse

Utilizzo di IntelliSense