Segue algumas convenções gerais de como escolher a palavra que será o nome de um identificador.
- O nome escolhido deve estar sempre ligado ao propósito do identificador. Deve ficar claro o que o identificador faz ou representa logo na primeira leitura do seu nome.
- Esqueça as abreviações e dê preferência para a clareza do nome. Abreviações não irão tornar seu código mais rápido. Ex. NomeDoFuncionário é mais fácil de entender que nmFunc.
- Não utilize hífens ou outros separadores de palavras nos nomes. Utilize PascalCase ou camelCase dependendo da situação.
- Esqueça a Notação Húngara.
- Tente evitar nomes que conflitem com palavras chave ou reservadas de outras linguagens de programação. Isso ajudará a evitar muitas dores de cabeça case seja necessário migrar o código para outras linguagens.
- Se for utilizar uma sigla, não invente, utilize apenas se a mesma for largamente conhecida. Ex. Html, Xml.
- Dê preferência para a utilização de nomes genéricos da CLR ao invés de nomes específicos da linguagem. Ex. Uma método que converte algo para boleano deve se chamar ConvertToBoolean e não ConvertToBool, pois Boolean é o nome base na CLR que é representado por bool em C#.
- Use um nome comum como value ou item quando um identificador é algo que não possui um propósito tão específico. Ex. void Gravar(double value) ; void Gravar(int value) ; void Gravar(short value) ;
- Quando for criar uma nova versão de uma API, crie um nome similar ao original. No novo nome, opte por utilizar sufixos ao invés de prefixos, assim ficará mais fácil de achar a nova função através do Intellisense. Se o nome antigo é o único que faz sentido para aquele propósito, utilize um sufixo numérico. Ex. public class Carro {...} -> public class Carro2 ou public class Automóvel.
- Nos casos dos métodos obsoletos, utilize o atributo [Obsolete(...)].
Referencias:
Nenhum comentário:
Postar um comentário