Comentário de cabeçalho no Visual Studio

Nesse post vamos mostrar como deixar seu código dentro das boas práticas de programação, utilizando comentário de cabeçalho nas suas classes dentro do Visual Studio.

Vamos começar instalando a extensão “License Header Manager” do Visual Studio Gallery (download).

Após a instalação abra o Visual Studio e acesse o menu Tool > Options. Note que foi acrescentado um item com o nome da extensão recém instalada, “License Header Manager”.

header_options

Ao expandir o item, temos 3 sub itens: General, Default Header e Languages. Cada um é responsável por uma configuração específica da extensão.

General

Nessa seção é possível configurar algumas preferências para a extensão, por exemplo: adicionar um comentário de cabeçalho automaticamente em novas classes criadas.

Default Header

Aqui será definido como vai ser o seu comentário de cabeçalho. Nesse exemplo estamos adicionando apenas cabeçalhos para arquivos com a extensão .cs (extensions: .cs) e estamos utilizando as propriedades FileName e UserName para obter o nome do arquivo e do usuário respectivamente. Para ver outras propriedades disponíveis acesse aqui.

extensions: .cs
//-----------------------------------------------------------------------
// <copyright file="%FileName%" company="TalkitBR">
// Copyright (c) talkitbr. All rights reserved.
// </copyright>
// <author>%UserName%&<author>
//-----------------------------------------------------------------------

header_options_default_header

Languages

Na última seção é definido as delimitações de comentários para cada tipo de arquivo, onde temos a extensão de cada documento com seus inícios e fins de comentários por linha ou por blocos.

header_options_languages

Feito essas alterações, o seu gerenciador de comentários de cabeçalho está configurado no Visual Studio. Agora precisamos adicionar no projeto: clique com o botão direito no seu projeto e selecione o item License Headers, ao abrir o sub menu escolha a opção Add New License Header Definition File.

header_solution_select_header

Vai ser criado um arquivo dentro do projeto com o nome <nome_do_projeto>.licenseheader, ao abrir esse arquivo você vai notar que é o mesmo conteúdo que criamos nos passos anteriores. Esse arquivo é totalmente customizável, as alterações feitas nele não afetarão as configurações padrões da extensão.

Seu projeto já está pronto para começar a usar os comentários de cabeçalho, ao criar uma nova classe o header já será incluído automaticamente.

Porém, há muitos casos que o projeto já possui diversas classes criadas, para isso a extensão oferece uma facilidade que é adicionar comentários de cabeçalho em todas as classes já existentes. Com o botão direito no projeto ou na solução selecione novamente o item License Headers e no sub menu selecione Add License Headers to All Files.