Procedura: creare commenti all'Elenco attività
Nell’Elenco attività vengono visualizzati i commenti nel codice, che iniziano con l’apposito marcatore per il linguaggio di sviluppo. Nell’in Elenco attività, accanto ai commenti, viene visualizzato un token di attività predefinito, ad esempio TODO, HACK o UNDONE, o un token di commento personalizzato. Il numero dei commenti visualizzati nell’Elenco attività può variare, in base al tipo di progetto in corso di elaborazione. Con Visual Basic e Visual C#, nell'Elenco attività sono visualizzati tutti i commenti contenuti nella soluzione. Con i progetti di Visual C++, nell’Elenco attività vengono visualizzati solo i commenti disponibili nel file attualmente attivo nell’editor.
È possibile utilizzare i commenti nell'Elenco attività per indicare le diverse operazioni da eseguire nella posizione contrassegnata, ad esempio:
funzionalità da aggiungere;
problemi da correggere;
classi da implementare;
indicatori da posizionare per il codice di gestione degli errori;
promemoria per l'archiviazione del file.
Come per le altre voci dell'Elenco attività, è possibile visualizzare il file indicato nell'editor di codice e passare alla riga di codice contrassegnata facendo doppio clic su qualsiasi voce di commento.
Per aggiungere un commento all'Elenco attività
Aprire un file di codice sorgente nell'editor di codice.
Iniziare un commento relativo a una riga di codice che si desidera contrassegnare con <indicatore><token>, dove <indicatore> rappresenta l'indicatore di commento per il linguaggio di sviluppo utilizzato e <token> corrisponde al nome di un token di commento riconosciuto dell'Elenco attività, come TODO, HACK o UNDONE, oppure a un token di commento personalizzato.
Nota
Per aggiungere token di attività a livello di codice, impostare la proprietà DefaultCommentToken dell'oggetto TaskList.
Completare il commento con testo descrittivo dell'attività. Di seguito è riportato un esempio:
// TODO Fix this function.In alternativa
' HACK Update this procedure.Scegliere Elenco attività dal menu Visualizza.
Verrà visualizzato l'Elenco attività.
Scegliere Commenti in Categorie.
Nell'elenco Commenti è visualizzato il testo del commento. Facendo clic su qualsiasi commento nell'Elenco attività è possibile attivare il file nell'editor di codice e passare alla riga di codice contrassegnata dal commento.
Per modificare un commento o rimuoverlo dall'Elenco attività
Aprire il file di codice per la modifica nell'editor di codice.
Modificare o eliminare il commento nel codice.
Per modificare la priorità predefinita di un commento
Scegliere Opzioni dal menu Strumenti.
Espandere la cartella Ambiente e selezionare Elenco attività.
In Elenco dei token selezionare il token di commento di cui si desidera modificare la priorità predefinita.
Nota
Non è possibile modificare la priorità per il commento TODO.
Nell'elenco a discesa Priorità selezionare un altro tipo di priorità.
Scegliere OK.
Per creare un token di commento personalizzato
Scegliere Opzioni dal menu Strumenti. Espandere la cartella Ambiente e selezionare Elenco attività.
È così possibile visualizzare Elenco attività, Ambiente, finestra di dialogo Opzioni.
Nella casella Token di commento digitare un nome per il token personalizzato.
Nell'elenco Priorità scegliere Normale, Bassa o Alta.
Fare clic su Aggiungi e scegliere OK.
Per ulteriori informazioni sull'aggiunta di token personalizzati all'Elenco attività, vedere Procedura: creare token di commento personalizzati.
Esempio
// The following C# code file contains several TODO reminders.
// Note that each line task reminder begins, like this comment,
// with the C# comment indicator, '//'.
// TODO: Add standard code header comment here.
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Windows.Forms;
// TODO: Add references to specific resources here.
namespace TodoExample
{
partial class TodoExample : Form
{
public TodoExample()
{
InitializeComponent();
}
}
}
// TODO: It is even possible to add comments at the end.
Nell'esempio viene illustrato che è possibile inserire commenti TODO in qualsiasi punto di un file di codice. I commenti nell'Elenco attività rappresentano in genere la soluzione ideale per fornire una breve indicazione delle operazioni da eseguire in righe o sezioni specifiche del codice. Risultano meno appropriati per descrizioni più estese di attività di sviluppo generali.
Vedere anche
Attività
Procedura: utilizzare i segnalibri nel codice
Procedura: controllare l'elenco attività
Riferimenti
Elenco attività (Visual Studio)
Inserimento di commenti al codice XML