Écrire du code maintenable

Question

Quel est le facteur le plus important pour écrire du code maintenable (indépendant de la langue)?

Answer 1

Écrire pour les autres à lire. Cela signifie une combinaison de noms, de bons commentaires, et de simples déclarations.

Une fois la mémoire était rare et le temps de cycle a été lent. les programmeurs ont été invités à écrire des complexes de lignes de code qui fait beaucoup de choses. Aujourd'hui, la mémoire est abondante et des temps de cycle rapides. Vous devriez écrire 5 lignes de code simple les gens peuvent suivre au lieu d'une seule ligne, ils ne peuvent pas comprendre.

Bon les commentaires n'ont pas à être long, mais il doit être utile.

Également être cohérent. Ne pas changer de style dans votre code. Par exemple ne pas changer de dénomination des styles à partir d'une section à l'autre.

Answer 2

La séparation des Préoccupations (de chaque méthode une chose) - cela s'arrête code Spaghetti.

EDIT: (En réponse à sacha commentaire) La clé de la maintenabilité est en train d'être rapidement en mesure de comprendre ce que fait le code et la façon de faire des changements dans le but d'accomplir une tâche.

Ayant le code de la séparation, de sorte que chaque tâche est assurée par une méthode de consacré à il fait un clin d'œil.

Par exemple, si je veux changer la manière dont le coude est plié sur les logiciels pour un robot, disposer d'une méthode nommée BendElbow en fait un no-brainer où le changement doit être fait.

Answer 3

Tests unitaires automatisés.

Vous pouvez modifier lentement la conception du code via une refactorisation si vous l'avez couvert de tests automatisés qui vous indiquent quand vous cassez des fonctionnalités existantes. Les tests automatisés rendent le changement de code moins risqué.

Answer 4

Bonne abstraction

Answer 5

Test unitaire haut la main. Si vous testez votre code à l'unité dès le départ, vous disposerez d'une suite de tests que vous pourrez exécuter pour valider la validité de votre code chaque fois que vous apporterez une modification.

De plus, lorsque vous écrivez du code avec un test unitaire, les méthodes ont tendance à être plus petites car elles sont plus faciles à tester. De plus, cela devrait vous encourager à faire vos méthodes pour une seule tâche - encore une fois car il est plus facile de tester de cette façon.