[PYTHON] Je veux que vous soyez conscient de ce que nous allons développer ensemble à partir de l'année prochaine. (À partir de "Code lisible")

Célèbres "Code lisible - Techniques simples et pratiques pour écrire un meilleur code" (http://www.amazon.co.jp/ Code lisible --- Techniques simples et pratiques pour écrire un meilleur code -Theory-practice-Boswell / dp / 4873115655) est lu brièvement, et je vais résumer ce que je voulais que les juniors qui évoluent avec moi sachent.

(Ce livre utilise Python, JS, Java et C ++ comme exemple de code.)

principe

"Le code doit être facile à comprendre"

Cool / court ≠ facile à comprendre / lire

Organisation superficielle

• Remplissez le nom de la variable / le nom de la fonction exactement avec des informations
• Divisez la déclaration de variable en groupes significatifs et ajoutez des commentaires à chaque groupe.
• N'écrivez pas consciemment des commentaires (contenu évident) qui ne devraient pas être écrits
• Clarifiez "vos pensées" et "les raisons pour lesquelles vous êtes parvenu à cette conclusion" lors de la rédaction du code
• La partie qui n'a rien à voir avec l'essence de la logique le montre fermement
• Répondez aux questions que vous vous posez absolument dans les commentaires
• Pour les fonctions complexes, donnez une image des entrées / sorties à l'aide d'un exemple
• Expliquez la fonction (ce que vous faites), pas la signification programmatique

Simplification logique

• Divisez les choses énormes en tailles faciles à manger (faciles à digérer lors de la lecture)
• Rendre les variables immuables
• Ne mettez pas de variables inutiles
• Distinguer et séparer la logique essentielle des sous-traitements non liés
• Enveloppez sans compromis sur une interface non idéale
• Exportez et organisez les tâches et ne mélangez pas plusieurs processus en même temps
• Gardez la portée variable petite

La description

• Essayez d'expliquer à haute voix ce que vous faites dans cette partie
• Focus sur les mots-clés utilisés dans l'explication
• Essayez à nouveau d'expliquer et d'organiser les fonctionnalités

Bien sûr, c'est un livre de programmation, mais il y a certaines parties (je pense) qui sont assez liées aux astuces de la présentation. En fin de compte, je pense qu'il s'agit de réfléchir à ce que vous pouvez faire pour raccourcir le temps de compréhension de l'autre partie.