Commentaires de Code dans un Service de langage héritéCommenting Code in a Legacy Language Service

En général, les langages de programmation fournissent un moyen d’annoter le code de commentaire.Programming languages typically provide a means to annotate or comment the code. Un commentaire est une section de texte qui fournit des informations supplémentaires sur le code, mais est ignoré pendant la compilation ou une interprétation supplémentaire.A comment is a section of text that provides additional information about the code but is ignored during compilation or interpretation.

Les classes de framework (MPF) package managé prennent en charge les commentaire et de supprimer le commentaire de texte sélectionné.The managed package framework (MPF) classes provide support for commenting and uncommenting selected text.

Styles de commentaireComment Styles

Il existe deux styles générales de commentaire :There are two general styles of comment:

  1. Commentaires sur une ligne où le commentaire se trouve sur une seule ligne.Line comments, where the comment is on a single line.

  2. Commentaires de bloc, où le commentaire peut inclure plusieurs lignes.Block comments, where the comment may include multiple lines.

    Commentaires sur une ligne ont généralement un caractère de début (ou caractères), lors de commentaires de bloc de caractères de début et de fin.Line comments typically have a starting character (or characters), while block comments have both start and end characters. Par exemple, en c#, un commentaire sur une ligne commence par / /, et commence par un bloc de commentaire / * et se termine par */.For example, in C#, a line comment starts with //, and a block comment starts with /* and ends with */.

    Lorsque l’utilisateur sélectionne la commande commenter la sélection à partir de la modifier -> avancé menu, la commande est acheminée vers le CommentSpan méthode sur le Source classe.When the user selects the command Comment Selection from the Edit -> Advanced menu, the command is routed to the CommentSpan method on the Source class. Lorsque l’utilisateur sélectionne la commande ne pas commenter la sélection, la commande est acheminée vers le UncommentSpan (méthode).When the user selects the command Uncomment Selection, the command is routed to the UncommentSpan method.

Prise en charge les commentaires de CodeSupporting Code Comments

Vous pouvez avoir vos commentaires de code langue service prise en charge par le biais de la EnableCommenting nommé de paramètre de la ProvideLanguageServiceAttribute .You can have your language service support code comments by means of the EnableCommenting named parameter of the ProvideLanguageServiceAttribute . Cela permet de définir la EnableCommenting propriété de la LanguagePreferences classe.This sets the EnableCommenting property of the LanguagePreferences class. Pour plus d’informations sur la définition de langage servicce fonctionnalités, consultez l’inscription d’un Service de langage hérité).For more information about setting language servicce features, see Registering a Legacy Language Service).

Vous devez également substituer la GetCommentFormat méthode pour retourner un CommentInfo structure avec les caractères de commentaire pour votre langage.You must also override the GetCommentFormat method to return a CommentInfo structure with the comment characters for your language. C#-caractères de commentaire de ligne de style sont la valeur par défaut.C#-style line comment characters are the default.

ExempleExample

Voici un exemple d’implémentation de la GetCommentFormat (méthode).Here is an example implementation of the GetCommentFormat method.

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;  
        }  
    }  
}  

Voir aussiSee Also

Fonctionnalités de Service de langage hérité Legacy Language Service Features
L’inscription d’un Service de langage héritéRegistering a Legacy Language Service