["Compétence de maîtrise du logiciel Clean Code Agile"](https://www.amazon.co.jp/Clean-Code-%E3%82%A2%E3%82%B8%E3%83%A3%E3%82 % A4% E3% 83% AB% E3% 82% BD% E3% 83% 95% E3% 83% 88% E3% 82% A6% E3% 82% A7% E3% 82% A2% E9% 81% 94 % E4% BA% BA% E3% 81% AE% E6% 8A% 80-Robert-C-Martin / dp / 4048930591) et résumez brièvement les règles que j'ai trouvées importantes pour garder mon code propre. C'était. Je pense qu'il est important de rendre votre code extensible et maintenable afin que les autres puissent lire votre code facilement.
** La méthode doit être aussi petite que possible (3, 4 lignes) ** Un rôle dans une méthode. S'il contient plusieurs processus, démontez-le.
** Jusqu'à 1 ou 2 tirets ** Utilisez moins si et pour les déclarations.
** Alignez le niveau d'abstraction dans la méthode. ** **
** Nom de méthode facile à comprendre. ** ** Pour que même ceux qui lisent le code pour la première fois puissent comprendre ce qu'il représente.
** Moins d'arguments. 0 est idéal, 2 ou moins. ** ** boolean n'est pas un argument. Passer boolean comme argument signifie qu'il y a une branche conditionnelle à l'intérieur.
** Élimine les effets secondaires. (Processus caché) ** Éliminez les traitements masqués qui ne peuvent pas être compris à partir du nom de la méthode.
** Rendez-le compréhensible sans regarder l'appelant de la fonction. ** ** Pour que vous puissiez voir ce que vous faites avec le nom de la méthode.
** Découpez le contenu de try catch dans une méthode. ** ** Si vous utilisez try and catch, ce sera difficile à voir.
** Principe DRY (Ne vous répétez pas). ** ** Ne répétez pas le même code.
** Encapsulation d'expression conditionnelle. Soyez aussi positif que possible. ** ** Ne pas utiliser! Ou pas ◯◯ autant que possible.
** Écrivez des variables et des méthodes privées à proximité de l'endroit où vous les utilisez. ** ** Il est facile à voir car il n'est pas nécessaire de faire défiler beaucoup dans le sens vertical.
** Utilisez des variables descriptives. ** ** Donnez un nom de variable à la valeur dans le processus de calcul.
** Encapsulation des conditions aux limites ** Extrayez la valeur limite utilisée dans les expressions conditionnelles en tant que nom de variable.
** Organisez les méthodes par ordre de niveau d'abstraction. ** **
** N'utilisez pas les commentaires autant que possible. ** ** Facilitez la compréhension par nom de méthode, nom de variable et nom de classe.
Le type procédural facilite l'ajout de fonctions ultérieurement. Orienté objet, il est facile d'ajouter des classes.
** Utilisez des exceptions non cochées. ** **
** Renvoie la classe d'exception au lieu du code d'erreur. ** **
** Écrivez suffisamment de journaux lorsque vous attrapez. ** **
** Ne retournez pas null. ** ** Il y a généralement beaucoup de vérifications nulles. Traitez-le en le renvoyant sous forme de liste vide.
** Ne passez pas null comme argument. ** ** Il existe peu de méthodes qui peuvent le gérer correctement lorsque null est passé. En principe, la transmission de null devrait être interdite.
Facilitez la compréhension de ce que vous testez.
La priorité est élevée dans l'ordre du haut. (② et ③ sont à peu près identiques) ① ** Passe les tests ** Le test réussit. Vous pouvez toujours vérifier que votre code fonctionne comme prévu.
② ** Révèle l'intention ** Clarifiez l'intention de l'auteur avec une bonne dénomination, en gardant les fonctions et les classes petites et en appliquant des modèles de conception.
③ ** Pas de duplication **
④ ** Moins d'éléments (minimiser les classes et les méthodes) ** Réduisez le nombre de fonctions et de classes.
Idéalement, vous devriez être en mesure de lire le code et de voir ce que vous faites, sans utiliser de commentaires. Personnellement, je voulais être capable d'écrire ** du code qui peut être lu de la même manière que la lecture du langage naturel ** en concevant des noms de variables, des noms de méthodes et comment diviser les classes. De plus, si vous avez un test, vous pouvez franchir le pas et le refactoriser. Je veux toujours écrire suffisamment de tests, en utilisant pleinement TDD, etc. pour que le code puisse être nettoyé à tout moment. En fait, il est souvent difficile de prendre le temps de nettoyer le code, mais soyez conscient des «règles du boy-scout» et ** rendez le code que vous trouvez plus propre que lorsque vous l'avez trouvé **. Je vais essayer de réduire le code sale.
Recommended Posts