Comentar o código em um serviço de linguagem herdadoComment code in a legacy language service

Linguagens de programação normalmente fornecem um meio de anotações ou comentários de código.Programming languages typically provide a means to annotate or comment the code. Um comentário é uma seção de texto que fornece informações adicionais sobre o código, mas é ignorada durante a compilação ou interpretação.A comment is a section of text that provides additional information about the code but is ignored during compilation or interpretation.

As classes do framework (MPF) de pacote gerenciado dão 1>{2>suporte a inserção e texto selecionado.The managed package framework (MPF) classes provide support for commenting and uncommenting selected text.

Estilos de comentárioComment styles

Há dois estilos gerais de comentário:There are two general styles of comment:

  1. Comentários de linha, em que o comentário é em uma única linha.Line comments, where the comment is on a single line.

  2. Comentários do bloco, em que o comentário pode incluir várias linhas.Block comments, where the comment may include multiple lines.

Comentários de linha geralmente têm um caractere (ou caracteres iniciais), enquanto os comentários do bloco têm caracteres iniciais e finais.Line comments typically have a starting character (or characters), while block comments have both start and end characters. Por exemplo, no c#, um comentário de linha começa com //, e um comentário de bloco começa com /* e termina com */.For example, in C#, a line comment starts with //, and a block comment starts with /* and ends with */.

Quando o usuário seleciona o comando seleção de comentário da editar > avançado menu, o comando é roteado para o CommentSpan método no 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. Quando o usuário seleciona o comando seleção Descomente, o comando é roteado para o UncommentSpan método.When the user selects the command Uncomment Selection, the command is routed to the UncommentSpan method.

Comentários de código de suporteSupport code comments

Você pode ter seus comentários de código do idioma serviço suporte por meio do EnableCommenting chamado de parâmetro do ProvideLanguageServiceAttribute .You can have your language service support code comments by means of the EnableCommenting named parameter of the ProvideLanguageServiceAttribute . Isso define a EnableCommenting propriedade do LanguagePreferences classe.This sets the EnableCommenting property of the LanguagePreferences class. Para obter mais informações sobre como definir recursos do serviço de linguagem, consulte registrar um serviço de linguagem herdado.For more information about setting language service features, see Register a legacy language service.

Você também deve substituir a GetCommentFormat método para retornar um CommentInfo estrutura com os caracteres de comentário para o seu idioma.You must also override the GetCommentFormat method to return a CommentInfo structure with the comment characters for your language. C#-caracteres de comentário de linha de estilo são o padrão.C#-style line comment characters are the default.

ExemploExample

Aqui está um exemplo de implementação do GetCommentFormat método.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;  
        }  
    }  
}  

Consulte tambémSee also

Recursos do serviço de linguagem herdado Legacy language service features
Registrar um serviço de linguagem herdadoRegister a legacy language service