Como saber mais sobre os estilos de codificação aceito

https://stackoverflow.com/questions/232975

04-07-2019
|

Pergunta

Onde ler-se sobre (a melhor prática em) o código-fonte formatação, para idiomas individuais ou seja, quais são as convenções para nomear variáveis ??etc., para o recuo e onde chaves lugar, como e onde incluir comentários, etc.

Por exemplo, para o livro de C Kernighan e Ritchie A Linguagem de Programação C Linus Torvalds' kernel Linux codificação guia de estilo ou Guia do Google C ++ Estilo e para Perl, pelo menos, perlstyle - Perl guia de estilo .

Edit:. Talvez eu devesse ter perguntado "Como obter um bom começo com estilos de codificação"

Solução

eu não daria muito em tal estilo-guias. Eles são um bom começo, mas no final você ou sua equipe irá desenvolver própria codificação-estilos.

EDIT: Rob Kam fez um comentário, que ele quer saber mais sobre estes 'iniciar-convenções'

Esse é um ponto bom. Mas, principalmente, você irá juntar-se projectos existentes, open-source-projetos ou comercial, e as pessoas que trabalham nele já tem um código-convenção. Em uma empresa, provavelmente, já existe uma convenção de código. Se você iniciar um novo projeto, comece com as convenções do outro projeto que você fez antes.

Se você realmente começar um novo projeto com um novo idioma que você não usou antes ... então você pode começar com as convenções de uma outra linguagem que é de alguma forma semelhante (ou seja, para um novo oo-idioma que você pode usar convenções de Java ou Smalltalk) e ajustar suas convenções como você ganhar experiência para o novo idioma. Como eu comecei a programação em Java que eu usei meus Pascal codificantes-convenções. Alguns dos Pascal-convenções não funcionou muito bom para Java, mas com o tempo eu deixei cair algumas velhas convenções e desenvolveu novo.

S.Lott teve a idéia de olhar para um código-fonte-projeto aberto escrito na linguagem de sua escolha. Essa é uma boa idéia para obter algumas sugestões sobre boas convenções. Srikanth teve a boa idéia de pedir boas convenções aqui no StackOverflow. Uma idéia muito boa, porque com o tempo Stackoverflow vai se tornar uma referência boa para codificação-convenções desta forma.

Outras dicas

O que é melhor do que um livro é para localizar o código-fonte aberto no seu idioma preferido.

Ao invés de um livro - o trabalho de alguns autores e editores -. Trabalhando código-fonte é um projeto da comunidade que atende altamente evoluído padrões da comunidade

Quando perguntado pelo cliente para ajuda com padrões de codificação, eu prefiro encontrar um bom projeto Open Source e fornecer um documento curto normas que diz "Faça parecer que xxx". Um bom exemplo que eu uso para o estilo Java é a Ant do projeto Apache .

Todo mundo tem seu projeto de exemplo de código aberto favorito. Leia alguns do mundo real, o código de trabalho, e escolher um favorito. Emular esse projeto.

Gostaria de usar o Google para isso. Por exemplo, para procurar Java Coding Guidelines, vou usar este consulta ou postar em Stack Overflow e perguntar quais são as recomendadas diretrizes de codificação padrão para Java. É difícil apontar uma única fonte para todas as línguas.

Gostaria de sugerir que você escolher um para sua empresa / projeto e ficar com ela e ter certeza que é um bom padrão.

Eu realmente recomendo para ler Clean Code tio de Bob se você estiver preocupados com questões de estilo de código.

Há três bons lugares para olhar.

livros populares sobre o idioma que você está usando.
projetos de código aberto escritos em seu idioma.
utilitários Checkstyle do tipo para seu idioma.

Se você usar uma ferramenta como Checkstyle ou PMD, estar ciente de que muitas das "regras" que impor pode ser controversa. Pode ser útil para verificar a documentação para descobrir quais as regras a ser cauteloso.

Microsoft tem um documento de referência com as suas convenções de codificação que podem ser úteis para olhar, mesmo se você não estiver usando C #. Além de estilo e básicos convenções, melhores práticas livros recomendados por outras pessoas aqui, como Clean Code , são leitura essencial para a criação de código de fácil manutenção, legível que vai fazer sentido para futuros mantenedores de sua base de código.

Se você estiver usando Visual Studio (e alguns outros IDEs modernos), inconsistências básicas com convenções recomendados são automaticamente sublinhadas (com sugestões sobre pairar nas versões recentes do VS). Na VS, se sua equipe quer usar diferentes padrões, basta abrir as propriedades do projeto e alterar as configurações para "análise de código" (item de menu última mão esquerda). Mais aqui: Usando conjuntos de regras para o código de grupo Regras para Análise

Olá e bom dia para todos

Bem, eu devo dizer que isso depende Depende se você trabalha para uma empresa ou se você trabalhar para você;)

Se você trabalha para uma empresa que você mus aceitar o estilo de nomeação e outras regras

e para você, você só precisa estabelecer um estilo que todos, incluindo você pode entender imediatamente o que e como

os suportes e os outros é o seu caminho

mas como você disse há línguas individuais para que eles tenham próprias regras

e como Mnementh disse que cada equipe tem uma maneira de codificação talvez restrita ou caminho livre

Isso é tudo com não mais .... bye bye

Há as guias de estilo C e C ++ , uma pequena página de links a guias de estilo, regras de codificação e discussões de USENET, mantido por Christopher Lott.

Se você é um PHP desenvolvedor estas duas guias não são para ser desperdiçada:

Licenciado em: CC-BY-SA com atribuição

Não afiliado a StackOverflow