O LintSpy é uma extensão desenvolvida para o Visual Studio que visa facilitar o trabalho em equipe, sugerindo a adoção das melhores práticas de nomenclatura e documentação em tempo real, visando assim um código C# limpo, claro e objetivo.

Notas de versão

Resumo

O LintSpy visa padronizar nomenclatura e documentação de códigos no momento da programação, sublinhando códigos em desacordo, exibindo na barra de rolagem a localização do ocorrido e sugerindo adoção das regras abaixo descritas. Também é possível visualizar todos as ocorrências através da lista de warnings do Visual Studio.

Desenvolvida pela equipe de TI da Coopavel (Cooperativa Agroindustrial de Cascavel/PR)

Veja abaixo um exemplo do LintSpy em funcionamento:

Exibição do warning no trecho incorreto e na barra de rolagem

Exibição da mensagem de erro ao deixar o cursor sobre o trecho marcado

Exibição de possibilidade de correção

Regras

1. Classes devem estar em Pascal Case;
2. O prefixo de variáveis deve seguir as tabelas na seção Prefixos. Classes internas não são consideradas;
3. Namespaces devem estar em Pascal Case;
4. Interfaces e classes abstratas devem ter o nome começando com a letra 'I';
5. Métodos devem possuir comentário de documentação;
6. O nome do método deve estar em Pascal Case;
7. Parâmetros de métodos devem iniciar com a letra 'p';
8. Atributos de classe devem possuir summary;
9. Underscores (_) não são permitidos para nenhum nome;
10. Constantes devem estar em Upper Case (Caso em que é permitido o uso de underscores);
11. Enums devem estar em Pascal Case;
12. Interfaces devem estar em Pascal Case após a letra 'I';
13. Parâmetros devem estar em Pascal Case após o 'p';
14. Variáveis devem estar em Pascal Case após o prefixo;
15. Underscores (_) não são permitidos para nomes de variáveis (Caso especial);
16. Parâmetros de um método devem estar no Summary do mesmo;
17. Campos do Summary não podem ficar em branco;
18. Propriedades devem estar em Pascal Case;
19. Estruturas de controle de fluxo devem possuir bloco delimitado por chaves ({});
20. Comentário não pode possuir parâmetros que não possuam correspondência;
21. Comentário deve ter o retorno do método devidamente comentado;
22. Pragma para desabilitar regras deve ter comentário com razão;

Prefixos

Prefixos de variáveis possuem três letras minúsculas seguindo as tabelas abaixo descritas.

Sobre Todos

As variáveis devem ser nomeadas utilizando o prefixo da tabela a seguir caso a classe em questão possua alguma das palavras listadas.

Demais

Classes que não possuam as palavras da tabela anterior devem utilizar o prefixo indicado na tabela abaixo de acordo com o nome da classe ou agrupamento.

Classes que não se encaixam nas regras de prefixagem acima listadas devem possuir o prefixo 'obj'.