supposition
Je viens de commencer la programmation (1~2 mois) J'ai résumé ce que j'ai appris.
Il peut y avoir des choses qui ne fonctionnent pas ou qui ne fonctionnent pas dans le domaine réel,
Si vous le remarquez, faites-le nous savoir dans les commentaires.
Je suis un débutant en programmation
Besoin d'écrire du code facile à lire
Comment puis-je écrire du code facile à comprendre?
J'ai résumé ce que j'ai appris.
Il y a trois raisons principales pour écrire du code facile à lire. ・ Augmentation de la productivité des individus et des organisations ・ Meilleure maintenabilité ・ Un système de développement flexible peut être construit Le développement par programmation étant essentiellement réalisé par plusieurs personnes, la productivité atteindra un plateau si vous avez seulement besoin de vous connaître, et vous serez loin d'un système de développement flexible.
** Refactoring ** est en cours pour atteindre ces trois. Qu'est-ce que le refactoring? Il s'agit d'améliorer le code source afin qu'il soit facile à lire sans affecter les fonctions implémentées. Cette refactorisation permet aux co-développeurs de comprendre et de modifier plus facilement le code implémenté.
La variable est nommée en tenant compte des autres (nom de la variable et de la fonction) Facile à lire sans logique compliquée (simplification de la logique) Les commentaires sont inclus et vous pouvez lire le code tout en saisissant l'image dans son ensemble (commentaires précis et simples)
Lorsque vous nommez des variables et des fonctions, évitez les noms abstraits et donnez-leur des noms concrets. Pour les noms de variables Définissez la valeur afin de voir le rôle de la variable. Pour le nom de la fonction Définissez ce qu'il faut faire et ce qu'il faut faire sous forme de verbe + nomenclature.
mauvais exemple
const one = 1;
Bon exemple
const userId = 1;
Dans un mauvais exemple, le nom de la variable on ne nous dit pas quelle est la valeur 1 et quel rôle elle a. Dans un bon exemple, vous pouvez voir en un coup d'œil que la variable est userId et la valeur 1 est l'ID utilisateur.
mauvais exemple
const add = () => {
En traitement
};
Bon exemple
const addTask = () => {
En traitement
}
Dans un mauvais exemple, je sais que j'ajoute quelque chose, mais je ne sais pas quoi ajouter. Dans un bon exemple, la tâche est jointe, vous pouvez donc comprendre en un coup d'œil qu'il s'agit d'un processus pour ajouter une tâche.
Deux facteurs principaux rendent le code plus compliqué. Lorsqu'il y a une description de la nidification dans la nidification Lorsque l'expression conditionnelle est compliquée
Qu'est-ce qu'un nid? L'imbrication est une structure imbriquée. Si vous le comparez à une expression conditionnelle, vous pourriez dire que l'imbrication est profonde lorsque vous écrivez if dans if, et if in that if. Cela signifie qu'il contient de nombreuses structures imbriquées.
Comme vous pouvez le voir dans cet exemple, plus il y a de structures dans une structure, plus la structure devient compliquée. Cela signifie qu'il est plus facile de lire le code si vous écrivez le moins de nids possible lors de l'imbrication. Contre-mesures spécifiques -Retournez la valeur de retour à un stade précoce et subdivisez le traitement lui-même. -Utiliser des opérateurs logiques.
Même si l'expression conditionnelle est longue, elle sera difficile à comprendre car il faut la lire du début à la fin pour comprendre le contenu du processus.
Si la description de l'expression conditionnelle devient longue, vous pouvez rendre le code plus concis et plus facile à comprendre en écrivant l'expression conditionnelle en tant que fonction et en appelant la description.
Même ainsi, c'est compliqué car il y a plusieurs expressions conditionnelles dans la description. Dans ce cas, la description peut être simplifiée en décomposant plusieurs expressions conditionnelles et en les divisant en plusieurs ifs.
Vous pouvez laisser un commentaire dans le code en commentant. Vous pouvez utiliser ce commentaire pour rendre la description plus facile à comprendre.
・ Si vous écrivez une logique compliquée, laissez un aperçu du processus et de vos pensées dans les commentaires. ・ Laissez pourquoi une telle description est faite
・ Commentaire supplémentaire
Ce sont les règles de base que je devrais connaître lors de l'écriture de code facile à comprendre que j'ai appris en tant que débutant en programmation. Si vous avez des ajouts ou des corrections, veuillez laisser un commentaire.
Recommended Posts