Comment écrire du code clair et efficace: 3 façons simples pour un programmeur



D'un traducteur: nous publions aujourd'hui pour vous un article d'un développeur indien Ravi Shankar Rahan. Il explique quoi faire si vous voulez apprendre à écrire du code simple et compréhensible. L'article est recommandé à tous les programmeurs débutants.

Écrire un code simple est facile. Mais si nous parlons de le préparer pour une utilisation future par quelqu'un, alors tout devient compliqué tout de suite. Le fait est qu'un tel code devrait être encore plus propre et compréhensible.

Le développeur doit créer un code qui peut être utilisé par n'importe lequel de ses collègues de n'importe quel pays du monde. Il devient donc quelque chose comme son «héritage». Tout cela sonne bien et pliant, mais la réalité est quelque peu différente ...

Skillbox recommande: Cours pratique de deux ans "Je suis un développeur Web PRO . "

Nous vous rappelons: pour tous les lecteurs de «Habr» - une remise de 10 000 roubles lors de l'inscription à un cours Skillbox en utilisant le code promo «Habr».

Le fait est qu'au début de mon voyage, même en acceptant le dogme ci-dessus, j'ai créé un code tellement monstrueux qu'il ne pouvait pas être qualifié de «bon». Il était presque impossible de comprendre et d'interpréter. Un peu plus tard, j'ai commencé à passer des jours et des mois sur la «correction» et la «revitalisation» des monstres que j'ai créés.

C'est difficile à programmer. Lorsque vous écrivez un programme dans lequel il y a des lignes de lignes, vous faites des erreurs. Parfois, ils sont importants, parfois pas très. Mais quelle que soit leur taille, il faut du temps pour les trouver et les réparer. Parfois, vous avez besoin d'aide pour sortir de l'entonnoir du désespoir et du désespoir que vous vous retrouvez à travailler sur votre code.

Parfois, vous avez besoin ... d'un canard en caoutchouc

Le concept du canard en caoutchouc a été proposé pour la première fois par Dean Parker dans son article sur l'oratoire. Parker dit que pour devenir un bon orateur, vous devez constamment vous entraîner à faire des discours. Et la meilleure façon de se débarrasser de la peur du public tout en apprenant à exprimer ses pensées de manière concise et intelligible est de parler lors des «formations oratoires» devant le canard en caoutchouc. Elle remplace juste le public.

En tant que programmeur, vous devez essayer d'expliquer chaque ligne de votre code à un canard en caoutchouc (réel ou imaginaire). Lorsque vous essayez de le faire, vous commencez à comprendre les forces et les faiblesses du code. Vous vous donnez l'occasion de le regarder de côté.

Voici quelques points importants que j'ai compris lors de l'application de cette pratique. Ils m'ont aidé à commencer à écrire sensiblement mieux.

La création de composants réutilisables n'est pas une nécessité permanente

Beaucoup ne sont pas d'accord avec moi, faisant valoir que les composants réutilisables sont toujours nécessaires, qu'ils doivent être réutilisés aussi souvent que possible. Disons que cela aide à améliorer la qualité du code et à travailler sur leurs propres erreurs. C'est vrai, mais seulement si vous créez le meilleur code du monde. Et personne n'a besoin de lui.

Non, bien sûr. Vous devez créer un logiciel qui remplit certaines conditions, y compris le budget. Vous pouvez également constamment peaufiner votre projet, le faire briller, perdre du temps, mais vous sentir comme un développeur idéal. Mais rappelez-vous: le logiciel est pertinent pour un temps limité, ce qui signifie que vous devez travailler rapidement, sinon vous ne finirez jamais.

Tu n'en auras pas besoin

L'axiome anglais d'origine ressemble à «YouArentGonnaNeedIt (YAGNI)». Vous devez comprendre ceci comme suit: "N'utilisez certains outils que lorsque vous en avez vraiment besoin, et ne pensez pas simplement qu'ils peuvent vous être utiles."

Il y a deux raisons à cela:
  • Vous gagnez du temps en évitant les travaux inutiles.
  • Votre code s'améliore à mesure que vous l'enregistrez des éléments «supposés» qui compliqueraient le programme.

Simplifiez tout au strict minimum

La programmation extrême a deux règles d'or pour créer du code simple.

Premièrement , la façon la plus simple d'introduire une nouvelle fonctionnalité est de la faire «fonctionner tout simplement». Pas besoin de créer des superstructures chics, quelque chose de high-tech. Faites simplement fonctionner la fonction. Mais n'oubliez pas que le code doit réussir les tests unitaires.

Deuxièmement , refactorisez le système afin que le code devienne aussi simple que possible, avec l'inclusion de toutes les fonctions actuelles. Il doit être aussi propre que possible.

Troisièmement , il vaut la peine d’apprendre que nous ne cherchons pas le moyen le plus rapide. Nous nous efforçons d'obtenir le résultat le plus simple (en termes de code). Par exemple, vous pouvez diviser une méthode existante en parties, ce qui laissera les fragments de test fonctionner, puis modifier chacune des méthodes de traitement, étape par étape.

Lorsque vous serez coincé la prochaine fois, essayez le canard

Trouver des bogues, des problèmes, un travail général sur le code est la partie principale de la programmation. Par conséquent, le développement de nos propres techniques de recherche et d'élimination des bogues, trouver votre chemin est une tâche critique.

Si vous êtes coincé quelque part et que rien ne fonctionne, essayez de vous esquiver.

Vous ne pouvez pas l'imaginer, mais achetez-le. Et peu importe qu'il s'agisse d'un canard ordinaire pour une baignoire ou d'un canard pirate - l'essentiel est que vous soyez à l'aise avec celui-ci afin qu'il corresponde à votre personnalité.

Et après cela, vous pouvez commencer une conversation avec un canard. Parlez-lui, posez des questions, expliquez à haute voix le problème avec lequel vous travaillez. Le résultat vous surprendra.

Chris Pine avait raison de dire: «La programmation n'est pas ce que vous savez, c'est ce que vous pouvez apprendre.»

Source: https://habr.com/ru/post/fr434304/


All Articles