Info

Usando convenções de nomenclatura Java

Usando convenções de nomenclatura Java

Uma convenção de nomenclatura é uma regra a seguir quando você decide como nomear seus identificadores (por exemplo, classe, pacote, variável, método etc.).

Por que usar convenções de nomenclatura?

Programadores Java diferentes podem ter estilos e abordagens diferentes para a maneira como programam. Ao usar as convenções de nomenclatura padrão do Java, eles facilitam a leitura do código para si e para outros programadores. A legibilidade do código Java é importante, pois significa menos tempo tentando descobrir o que o código faz, deixando mais tempo para corrigi-lo ou modificá-lo.

Para ilustrar o ponto, vale a pena mencionar que a maioria das empresas de software terá um documento que descreve as convenções de nomenclatura que eles desejam que seus programadores sigam. Um novo programador que se familiarizar com essas regras poderá entender o código escrito por um programador que pode ter deixado a empresa muitos anos antes.

Escolhendo um nome para seu identificador

Ao escolher um nome para um identificador, verifique se é significativo. Por exemplo, se o seu programa lida com contas de clientes, escolha nomes que façam sentido para lidar com clientes e suas contas (por exemplo, customerName, accountDetails). Não se preocupe com o tamanho do nome. Um nome mais longo que resume perfeitamente o identificador é preferível a um nome mais curto que pode ser rápido de digitar, mas ambíguo.

Algumas palavras sobre casos

Usar a caixa da letra certa é a chave para seguir uma convenção de nomenclatura:

  • Minúsculas é onde todas as letras de uma palavra são escritas sem maiúsculas (por exemplo, while, if, mypackage).
  • Maiúsculas é onde todas as letras de uma palavra são escritas em maiúsculas. Quando houver mais de duas palavras no nome, use sublinhados para separá-las (por exemplo, MAX_HOURS, FIRST_DAY_OF_WEEK).
  • CamelCase (também conhecido como Upper CamelCase) é onde cada nova palavra começa com uma letra maiúscula (por exemplo, CamelCase, CustomerAccount, PlayingCard).
  • Caso misto (também conhecido como Lower CamelCase) é o mesmo que CamelCase, exceto que a primeira letra do nome está em letras minúsculas (por exemplo, hasChildren, customerFirstName, customerLastName).

Convenções de nomenclatura padrão do Java

A lista abaixo descreve as convenções de nomenclatura Java padrão para cada tipo de identificador:

  • Pacotes: Os nomes devem estar em minúsculas. Em pequenos projetos que possuem apenas alguns pacotes, não há problema em fornecer nomes simples (mas significativos!):

    pacote pokeranalyzer pacote mycalculatorNas empresas de software e nos grandes projetos em que os pacotes podem ser importados para outras classes, os nomes normalmente serão subdivididos. Normalmente, isso começa com o domínio da empresa antes de ser dividido em camadas ou recursos:

    pacote com.mycompany.utilities pacote org.bobscompany.application.userinterface

  • Classes: Os nomes devem estar no CamelCase. Tente usar substantivos porque uma classe normalmente representa algo no mundo real:

    classe Classe de cliente Conta

  • Interfaces: Os nomes devem estar no CamelCase. Eles tendem a ter um nome que descreve uma operação que uma classe pode fazer:

    interface Interface comparável EnumerávelObserve que alguns programadores gostam de distinguir interfaces iniciando o nome com um "I":

    interface IComparable interface IEnumerable

  • Métodos: Os nomes devem estar em maiúsculas e minúsculas. Use verbos para descrever o que o método faz:

    void calculaTaxa () string getSurname ()

  • Variáveis: Os nomes devem estar em maiúsculas e minúsculas. Os nomes devem representar o que o valor da variável representa:

    string firstName int orderNumberUse apenas nomes muito curtos quando as variáveis ​​tiverem vida curta, como em loops for:

    for (int i = 0; i <20; i ++) {// eu só moro aqui}

  • Constantes: Os nomes devem estar em maiúsculas.

    estático final int DEFAULT_WIDTH estático final int MAX_HEIGHT