Condividi tramite

Codice di commento (managed package Framework)

  • Articolo

I linguaggi di programmazione in genere forniscono un mezzo per annotare o impostarlo come commento il codice. Un commento è una sezione di testo che fornisce informazioni aggiuntive sul codice ma verrà ignorato durante la compilazione o l'interpretazione.

Le classi gestite del framework (MPF) del pacchetto forniscono supporto per il commento e rimuovere il commento dal testo selezionato.

stili di commento

Esistono due stili generali del commento:

  1. Allineare i commenti, dove il commento viene su una sola riga.

  2. Bloccare i commenti, dove il commento può comprendere più righe.

I commenti della riga in genere un carattere iniziale (o caratteri, mentre le osservazioni di blocco sono entrambi i caratteri iniziale e finale. In c, ad esempio, un commento la riga inizia con //e l'avvio di un commento di blocco con/* e termina con */.

Quando l'utente seleziona il comando selezione di commento da Modifica - il menu di > Avanzate , il comando viene indirizzato al metodo di CommentSpan sulla classe di Source . Quando l'utente seleziona il comando Rimuovere il commento dalla selezione, il comando viene indirizzato al metodo di UncommentSpan .

Commenti del codice di supporto

È possibile disporre i commenti del codice di supporto del servizio di linguaggio per utilizzare il parametro denominato di EnableCommenting di ProvideLanguageServiceAttribute . Questo imposta la proprietà di EnableCommenting della classe di LanguagePreferences . Per ulteriori informazioni sulle funzionalità di servicce di linguaggio impostazione, vedere Registrando un servizio di linguaggio (managed package Framework).

È inoltre necessario eseguire l'override del metodo di GetCommentFormat per restituire una struttura di CommentInfo con i caratteri di commento per il linguaggio. i caratteri stile c# di commento la riga è l'impostazione predefinita.

Esempio

Di seguito è un'implementazione di esempio del metodo di GetCommentFormat .

using Microsoft.VisualStudio.Package;

namespace MyLanguagePackage
{
    class MySource : Source
    {
        public override CommentInfo GetCommentFormat() {
            CommentInfo info = new CommentInfo();
            info.LineStart       = "//";
            info.BlockStart      = "/*";
            info.BlockEnd        = "*/";
            info.UseLineComments = true;
            return info;
        }
    }
}

Vedere anche

Concetti

Registrando un servizio di linguaggio (managed package Framework)

Altre risorse

Funzionalità del servizio di linguaggio (managed package Framework)