Um documento de padrões de codificação é útil. É mais útil quando é curto o suficiente para que alguém possa se lembrar da coisa toda sem muitos problemas e quando não causa muita dor a ninguém.
Como você escolhe recuar o código em sua organização, colocar nomes em maiúscula, implementar seus loops ou comentar seu código não importa tanto; a parte útil é fazer com que todos escrevam um código parecido com o de todos os outros.
- Isso evita que você gaste um minuto recalibrando sua expectativa de onde os aparelhos devem estar e assim toda vez que você olha o código de outra pessoa.
- Evita ter vários estilos diferentes de código, todos no mesmo arquivo.
- Talvez o mais importante seja que ter um padrão escrito evite argumentos sobre práticas de codificação durante as revisões de código.
Novamente, o que são os padrões não importa tanto quanto ter algum tipo de padrão simples e direto. Portanto, coloque todos os seus desenvolvedores em uma sala e deixe-os discutir sobre quais devem ser os padrões. Esta reunião pode durar indefinidamente, portanto as regras são:
- Tudo o que não for decidido até o final da reunião será decidido pelo gerente.
- A reunião terminará após duas horas, ou quando alguém começar a gritar ou chorar, o que ocorrer primeiro.
- Todo o padrão cabe (em tamanho razoável!) Em uma ou duas folhas de papel, frente e verso somente se for absolutamente necessário.
Considere adotar alguém | de outra pessoa | padrões como ponto de partida para sua própria reunião de padrões de codificação ou como uma maneira de evitar a reunião por completo.
Uma vez acordado, os desenvolvedores devem poder (e deve-se) policiar a si mesmos. Desvios ocasionais do padrão não devem ser um grande problema (e podem até ser justificáveis), mas a recusa em abandonar algum estilo pessoal favorito em favor do padrão deve resultar em imediata mudança para o escritório com os canos de água com vazamento, ou o que seja .
Demian Brecht aponta para ferramentas de cotão. Estes são um complemento perfeito para um documento de padrões de codificação. É simplesmente bom manter os padrões de estilo de codificação ; é importante manter os padrões de codificação relacionados a práticas perigosas. Ninguém além do autor verificará se todas as linhas de código atendem ao padrão de estilo, mas você certamente deve considerar a possibilidade de criar uma ferramenta de fiapos no fluxo de trabalho de sua equipe para detectar automaticamente erros prováveis. Além disso, a própria ferramenta pode codificar as práticas aceitas, para que você não precise listá-las todas individualmente nos padrões de codificação; basta especificar a configuração da ferramenta.
Nota: A idéia "padrões de codificação" não é exclusiva da programação. Os "padrões de codificação" são usados em muitos campos, às vezes dentro de uma organização, com mais frequência em toda uma indústria ou profissão. Alguns exemplos:
Em cada caso (e muitos outros), um profissional competente pode entender facilmente "código" que não atende ao padrão esperado. Por que tantas indústrias persistem em escrever requisitos detalhados para documentos que nem precisam ser analisados por um compilador? Porque o estilo é importante . A apresentação de informações em um estilo padrão permite que o leitor se concentre inteiramente no conteúdo, torna a leitura mais rápida, ajuda na compreensão e reduz erros.