Titulo do meu documento

Normatização de Codigo
Para Aplicações Java EE6 Versão Desenvolvedor

Versão 1.0 de 18/09/2013

Histórico de Revisões
Versão
Data
Responsável
Motivação
1.0
18/09/2013
Gabriel Mathias, PauloBaroni, ThiagoRibeiro.
Elaboração inicial desta norma de codificação

Índice
Conteúdo
Objetivos 3
Padrões de Estilo de Codificação 4
Hashtags - Ou “Como resolver ressalvas na avaliação do meu código ?” 4
#Constante (CONFORMIDADE) 4
#Mensagem (CONFORMIDADE) 9
#Enumerável (RESSALVA) 10
#PMD + {subtipo} (CONFORMIDADE OU RESSALVA) 10
#Javadoc (RESSALVA) 10
#MethodSignature(CONFORMIDADE) 12
#LineTooLong (RESSALVA) 16
#DeadCode (CONFORMIDADE) 16
#Deprecated(CONFORMIDADE) 16
#JavaFormatting (RESSALVA) 16
#JavaNaming (CONFORMIDADE) 17
#StringMisuse (CONFORMIDADE) 17
#UseNamedQuery (CONFORMIDADE) 18
#UseDTO(CONFORMIDADE) 19
#SupressWarning (RESSALVA) 19
#XhtmlNaming(CONFORMIDADE) 19
#CheckPagesXml (RESSALVA) 19
#CheckPersistenceXml (CONFORMIDADE) 19
#CheckPomXml (CONFORMIDADE) 20
#CheckComponents (CONFORMIDADE) 20
#Web.xml(CONFORMIDADE) 21

Objetivos
O objetivo principal deste documento é normalizar tanto a estrutura do código produzido dentro e/ou em conjunto com o INEP, para com isso:
Garantir eficiência e escalabilidade e segurança (estes 3 fatores não são separáveis pela natureza dos negócios da maioria dos sistemas do INEP)
Aumentar a qualidade e homogeneidade do código.
Facilitar a depuração e a manutenção
Ajudar o desenvolvedor
Dica importante
Lembre-se que o código que você produz não é seu. Lembre-se de que mais que eventualmente você terá que manter código feito por outra pessoa e que o código que você produz será manutenido por outro. Pense em você e no outro!
Todas as boas práticas de desenvolvimento são, em princípio, acolhidas neste documento, desde que não conflitem diretamente com as diretrizes aqui apontadas. Continue a aplicar o que você já sabe aplicar bem.
Estética do código
O código deve ser