normas e convenções de codificação para linguagens de programação como Java são projetados para melhorar a qualidade ea confiabilidade das aplicações construídas usando esses idiomas. Projetos Java são muitas vezes grande, com componentes variados trabalhado por um número de diferentes desenvolvedores. Ter um conjunto compartilhado de práticas significa que os desenvolvedores podem trabalhar com código de todos de forma mais eficaz , já que o código é mais claro e fácil de ler. Nomeando
convenções Java ditar certas regras para nomear os elementos do programa , como variáveis , classes, objetos , pacotes e interfaces entre outros. CamelCase é usado na maioria dos casos, como nos exemplos a seguir :
//Classe nomes começam maiúsculas
class MyClass
//variáveis começar minúsculas
objeto anObject
Em geral, use nomes significativos , por exemplo "contra " em vez de "c" para que as pessoas (incluindo você) a ler o seu código pode compreendê-lo mais facilmente.
recuo
Recuo é um dos elementos-chave de programação que torna o código mais fácil de ler . Recuo deve geralmente refletem as estruturas lógicas em um programa, e ajuda a identificar informações em um piscar de olhos , por exemplo, as variáveis de escopo de . Convenções Java também ditar onde as quebras deve ocorrer dentro de linhas repartidas de código, com as quebras de linha preferido ocorrido após vírgulas e antes de operadores , como segue:
aMethod ( parameterOne , parameterTwo ,
parameterThree );
int answer = itemOne + itemTwo
+ itemThree ;
As segundas linhas nestes casos idealmente deve vir após oito espaços
< . br> comentários
O uso de comentários torna todo o código mais fácil de trabalhar , especialmente se algoritmos extensos ou complexos estão envolvidos. Os comentários de código de acordo com as convenções de Java deve ser incluído antes das declarações de variáveis-chave , métodos , classes e todas as estruturas longas , assim como dentro de tudo isso. Use ambos os comentários individuais e multi- linha , ocorrendo em suas próprias linhas , ou no final de linhas de código :
/*
* Este é um comentário em um bloco
* /Tablet
//Este é um comentário única linha
int contador = 0; //Este é obter informações adicionais sobre a linha de código
Documentação < br >
criar documentação Java principalmente usando a facilidade Javadoc , que gera os documentos HTML recursos Java mais padrão e aplicativos usam , incluindo a própria língua . Você cria conteúdo Javadoc no código fonte usando comentários Javadoc :
/**
* Este é um comentário Javadoc
* - observe o asterisco duplo para começar
* /Tablet
Quando os desenvolvedores estão trabalhando com o código que foi desenvolvido por outra pessoa, o seu primeiro ponto de referência é muitas vezes o Javadoc , uma vez que fornece uma visão geral do recurso sem ter que ler , na verdade, o próprio código .
projeto Programa
Há muitas convenções e padrões para os detalhes de implementação dentro de programas Java. Um exemplo é a abordagem de fornecer acesso às variáveis em uma classe de código externo . (Veja Referências 4) Recomenda-se geralmente para manter variáveis de classe privada , e proporcionar o acesso a eles através de métodos públicos. Por exemplo, se uma classe tem uma variável de instância seqüência de texto com o nome " someData " poderia ter um método de fornecimento de acesso a ele a partir de outro lugar no aplicativo :
cadeia pública getData () {return someData ;}