Wiki
Convenção desenvolvedor
Objetivos e princípios #
Este documento tem como finalidade determinar os padrões e convenções a serem seguidos no desenvolvimento de aplicações em Java pelos desenvolvedores do Framework Demoiselle. Para a leitura deste documento é recomendável o conhecimento prévio da linguagem Java.
Uma padronização na programação precisa ser adotada a fim de manter consistente por todo um projeto e para facilitar subsequentes manutenções corretivas e evolutivas em seu código. Além disso, o uso de componentes de software é facilitado através da adequação aos padrões internacionais.
A Sun Microsystems publicou em 1997 um padrão de desenvolvimento para a linguagem Java entitulado Java Code Conventions. Tais regras tornaram-se o padrão no mundo do desenvolvimento Java. O presente documento apenas aponta e especifica tais regras levando em consideração o contexto específico do Framework Demoiselle. Este documento também baseou-se no documento "Padrões e Convenções para Código Java" elaborado para o Framework Pinhão Paraná, da CELEPAR.
Convenção de idioma #
Para a nomeação de artefatos de código e documentação destes na forma de comentários no Framework Demoiselle é recomendada a utilização do idioma inglês.
Para aplicações específicas, o projetista é livre para nomear classes, variáveis e métodos de acordo com termos específicos à regra de negócio em sua língua original, porém é recomendável adotar a língua inglesa quando da existência de componentes técnicos potencialmente reusáveis desenvolvidos na aplicação.
Caracteres utilizáveis #
Em geral a nomeação de classes, parâmetros, atributos e métodos usa as seguintes faixas de caracteres alfanuméricos: a-z, A-Z e 0-9. A utilização de caracteres especiais ("?", "!", "@", "ç", ...) e acentos ("á", "ã", "é", "í", "ó", ...) nos nomes é proibida. O underscore "_" pode ser utilizado para a nomeação de constantes ou de valores enumerados.
Legibilidade #
Como em qualquer linguagem, é muito importante fornecer comentários relevantes ao código. Por exemplo, é inútil repetir o nome de um método na forma de uma sentença. A preferência deve sempre ser dada aos identificadores (nomes de atributos, métodos, etc) com comentários sucintos.
O princípio importante a ser adotado é a legibilidade do código. Os códigos fontes de um programa interessam tanto ao compilador quanto ao desenvolvedor. Devemos lembrar todas as vezes que o código precisará ser mantido. E essa manutenção, corretiva ou evolutiva, por vezes é efetuada por outra pessoa diferente do desenvolvedor inicial.
Repositório de Fontes #
O repositório oficial de fontes, a partir da versão 2, é o GitHub os códigos das versões anteriores continuam no SVN http://svn.frameworkdemoiselle.gov.br/ neste link você encontrará um guia para uso do Github.
Convenções para codificação #
