Conceito: Padrão de Codificação |  |
Um padrão que descreve várias convenções de codificação usadas para implementações inteligíveis, consistentes e com qualidade.
Relacionamentos
Elementos Relacionados | Desenvolvimento Implementação Re-fatoração
Descrição Principal
O uso de um padrão de codificação é uma prática de desenvolvimento de software extensamente aceita. A necessidade desta prática reside na importância da criação de um ambiente altamente colaborativo. A equipe deve ter uma forma padrão para nomear e formatar o código para que possam compreendê-lo rapidamente e saber onde procurar o que precisam. Isto permite a propriedade do código compartilhado de forma que qualquer membro da equipe possa entender rapidamente o código escrito pelos outros. Idealmente, o padrão de codificação deve ser o resultado do consenso da equipe. O envolvimento dos membros da equipe ajudará na adoção dos padrões. Os Padrões de Codificação cobrem as seguintes áreas: Padrão de nomenclatura. Inclui a nomenclatura de elemento de todas as formas até a menor variável. Na cobertura de elementos de larga escala, ele se transforma no pode ser considerado de padrões de design. Organização de arquivos. Inclui a convenção de nomenclatura de arquivos e como os arquivos serão organizados no sistema de arquivos. Padrões para comentários. Muita ênfase nos comentários implica em uma falta de confiança de que o código escrito não é inteligível, e também existe sempre uma preocupação de que os comentários não estejam atualizados. No entanto, uma abordagem coerente para os comentários melhora o entendimento e pode suportar a capacidade de gerar documentação a partir do código. Convenções de Codificação A aplicação coerente de convenções específicas em nível de código e a exclusão de algumas formatações consideradas pobres melhoram a qualidade do código. Espaço em branco. Embora se possa argumentar ser menos crítico do que os outros itens listados aqui, o uso consistente de espaços em branco, como indentações e linhas em branco, também melhora a legibilidade. Em alguns casos, as decisões serão arbitrárias (tal como quanto indentar). Cada item no padrão deve suportar uma ou mais metas, a melhoria da comunicação é uma das metas mais críticas. Uma vez que a equipe concorde com um padrão, espera-se que todos os membros das equipes sigam-no. Com o tempo, a equipe usará e modificará o padrão até desenvolver um estilo que fique bem adaptado ao ambiente. Embora algumas normas possam transcender qualquer linguagem, os padrões de codificação devem ser específicos para a linguagem na maior parte dos casos. Para exemplos de padrões de codificação, veja Convenções de Codificação para a Linguagem de Programação JavaTM ou Diretrizes para Codificação Interna para desenvolvimento .NET.
Este programa e o material que o acompanha são disponibilizados sob a Eclipse Public License v1.0 que acompanha esta distribuição. Direitos Autorais do OpenUP.