Y a-t-il des normes et pratiques de base pour rendre le code lisible par l'homme?

Question

Plus précisément faire des pages HTML, Java et Python plus lisible? Quelqu'un at-il des suggestions pour cet étudiant de programmation?

Answer 1

1. Utilisez enveloppe constante et nommage.

2. Utiliser des languettes (et les supports le cas échéant) afin de fournir un flux visuel.

3. Utilisez les commentaires qui expliquent ce qui se passe sur le plan conceptuel, ainsi que sur le plan technique. (Par exemple, // Avons-nous un utilisateur valide? // pas Vérifiez que user_ID est pas -1)

Je suis sûr que certains développeurs plus expérimentés auront plus de suggestions, mais ce sont mon top 3.

Answer 2

indention bonne et commentaires instructifs.

Answer 3

Utilisez indentation, les commentaires et les conventions de codage (pour Python vérifier pep8 )

Answer 4

Assurez-vous que votre code est bien structuré (indentation appropriée, des lignes vides pour séparer les sections de code, etc.) et le niveau d'utilisation, cohérente et complète du nom (plutôt que abrégée incompréhensible) les noms de variables.

D'autres suggère d'utiliser des commentaires appropriés. Je aurais tendance à être en désaccord. Si votre code est bien structuré et des variables bien son nom, alors les commentaires seraient tout simplement encombrer les choses. L'exception à la règle être lorsque vous devez faire quelque chose contre-intuitif de travailler autour d'un bug quelque part ailleurs (j'ai eu recours à ce WCF et Entity Framework Code dans le passé).

Answer 5

Essayez de lire votre code à haute voix (ou au moins dans la tête).

Answer 6

Jetez un oeil à ce livre: code propre: un manuel de savoir-faire logiciel agile . Il est tout au sujet de rendre le code lisible et compréhensible.

Answer 7

Un conseil est de ne pas être paresseux avec des noms. Par exemple, si vous avez une classe Java qui est une implémentation de l'interface de transformateur, et il se transforme String à Date, ne hésitez pas à nommer le StringToDateTransformerImpl de classe.

Answer 8

Eh bien, vous pouvez toujours utiliser le "test ignorant". Montrez votre code à quelqu'un qui ne connaît absolument rien au sujet de la programmation. S'il peut voir plus ou moins ce que fait une fonction, le code est probablement lisible.

Answer 9

indentation correcte lorsque l'écriture HTML peut être une bouée de sauvetage, en particulier lorsque vous êtes en interaction avec toute sorte d'éléments imbriqués. Juste être compatible avec l'indentation et assurez-vous de mettre à jour les lignes entourant lorsque vous déplacez ou supprimez un élément en retrait. Cela rend beaucoup plus facile de mettre à jour la page, comme le niveau d'indentation donnera un indice quant à l'endroit où vous êtes dans la page sans avoir recours à une sorte de manœuvre Ctrl + F.

Il est également intéressant de noter que si vous utilisez CSS conjointement avec le HTML, la dénomination correcte est essentielle! Il permettra d'améliorer votre flux de travail et la lisibilité de votre code.

Je suis aussi un grand fan de l'empreinte, l'espacement et commentaires lors de l'écriture de code "réel" (Java, Python, C, etc.). Je me penche vers (x + 1) sur (x + 1) parce que je pense personnellement que ce fait une grande différence dans la lisibilité. Je espacer moulages, incréments, etc., et ils attrapent mon oeil beaucoup plus facilement. Soyez cohérent avec votre style support / indentation et commenter généreusement - rappelez-vous, re-écrire un nom de méthode n'est pas un commentaire