Existem normas básicas e práticas para tornar legível o código?

Question

Mais especificamente, tornando HTML, Java, python e mais legível?Alguém tem sugestões para este aluno de programação?

Answer 1

1. Use invólucro consistente e nomeação.

2. Use guias (e suportes, quando disponíveis) para fornecer um fluxo visual.

3. Use comentários que expliquem o que está acontecendo conceitualmente e tecnicamente. (por exemplo, // temos um usuário válido? Não // verificar que user_id não é -1)

Tenho certeza de que alguns desenvolvedores mais experientes terão mais sugestões, mas esses são os meus 3 primeiros.

Answer 2

Indivência adequada e comentários informativos.

Answer 3

Use indentação, comentários e convenções de codificação (para verificação python Pep8 )

Answer 4

Certifique-se de que seu código está bem estruturado (adequada recuo, linhas em branco para separar seções de código, etc.) e usar padrão, consistentes e totalmente nomeado (ao invés de incompreensível abreviado) nomes de variáveis.

Outros sugerem o uso adequado de comentários.Eu tendem a discordar.Se o seu código é bem estruturado e variáveis bem o nome e, em seguida, os comentários seriam apenas deixam as coisas.A exceção à regra é quando você tem de fazer algo contra-intuitivo para contornar um bug em algum outro lugar (eu tive de recorrer a este em WCF e o Entity Framework de código no passado).

Answer 5

Tente ler seu código em voz alta (ou pelo menos na sua cabeça).

Answer 6

Dê uma olhada neste livro: Código limpo: um manual de artesanato de software ágil. Trata -se de tornar o código legível e compreensível.

Answer 7

Um conselho não é ser preguiçoso com nomes. Por exemplo, se você tem uma classe Java, que é uma implementação da interface do transformador e transforma String para Date, não hesite em nomear a classe StringToDateTransformerImpl.

Answer 8

Bem, você sempre pode usar o "teste ignorante". Mostre seu código para alguém que não sabe absolutamente nada sobre programação. Se ele pode ver mais ou menos o que uma função faz, o código provavelmente será legível.

Answer 9

O recuo adequado ao escrever HTML pode ser um salva -vidas, especialmente quando você está interagindo com qualquer tipo de elementos aninhados. Apenas seja consistente com o recuo e não se esqueça de atualizar as linhas circundantes ao mover ou excluir um elemento recuado. Isso facilita muito a atualização da página, pois o nível de indentação dará uma pista sobre onde você está na página sem recorrer a algum tipo de manobra Ctrl+F.

Também vale a pena notar que, se você estiver usando CSS em conjunto com HTML, a nomeação adequada é crítica! Isso melhorará seu fluxo de trabalho e a legibilidade do seu código.

Também sou um grande fã de recuo, espaçamento e comentários ao escrever o código "Real" (Java, Python, C, etc.). Eu me inclino para (x + 1) sobre (x + 1) porque pessoalmente acho que faz uma grande diferença na legibilidade. Eu os elenco, incrementos, etc., e eles chamam minha atenção com muito mais facilidade. Seja consistente com o seu estilo de suporte/indentação e comente liberalmente - lembre -se, reescrever um nome de método não é um comentário!