Comentando o código (estrutura de pacote gerenciado)

Linguagens de programação geralmente fornecem um meio de anotações ou comentários do código. 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.

As classes do framework (MPF) de pacote gerenciado oferecem suporte para comentário e uncommenting texto selecionado.

Estilos de comentário

Existem dois estilos gerais de comentário:

1. Comentários de linha, onde o comentário é em uma única linha.

2. Comentários do bloco, onde o comentário pode incluir várias linhas.

Comentários de linha normalmente têm um caractere inicial (ou caracteres), enquanto o bloco de comentário têm caracteres de início e de término. Por exemplo, em C#, um comentário de linha começa com / /, e um comentário de bloco começa com / * e termina com * /.

Quando o usuário seleciona o comando Seleção como comentário partir do Editar -> Advanced menu, o comando será roteado para o CommentSpan método na Source classe. Quando o usuário seleciona o comando Seleção Descomente, o comando será roteado para o UncommentSpan método.

Comentários do código de suporte.

Você pode ter seus comentários de código do idioma serviço suporte por meio do EnableCommenting chamado parâmetro da ProvideLanguageServiceAttribute . Isso define o EnableCommenting propriedade da LanguagePreferences classe. Para obter mais informações sobre como definir o idioma servicce recursos, consulte Registrando um serviço de linguagem (estrutura de pacote gerenciado)).

Você também deverá substituir o GetCommentFormat método para retornar um CommentInfo estrutura com os caracteres de comentário para o seu idioma. C#-caracteres de comentário de linha de estilo são o padrão.

Exemplo

Aqui está um exemplo de implementação da GetCommentFormat método.

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ém

Conceitos

Registrando um serviço de linguagem (estrutura de pacote gerenciado)

Outros recursos

Recursos de serviço de linguagem (estrutura de pacote gerenciado)