10 conseils pour rédiger un code plus propre et mieux

Écrire du code propre semble plus simple qu'il ne l'est en réalité, mais les avantages en valent la peine. Voici comment vous pouvez commencer à écrire du code plus propre aujourd'hui.

Écrire du code propre semble plus simple qu'il ne l'est en réalité, mais les avantages en valent la peine.  Voici comment vous pouvez commencer à écrire du code plus propre aujourd'hui.
Publicité

Sans aucun doute, la programmation est difficile Comment apprendre la programmation sans tout le stress Comment apprendre la programmation sans tout le stress Peut-être que vous avez décidé de poursuivre la programmation, que ce soit pour une carrière ou tout simplement comme un passe-temps. Génial! Mais peut-être que vous commencez à vous sentir dépassé. Pas si bien. Voici de l'aide pour faciliter votre voyage. Lire la suite . C'est une chose d'apprendre les langages et les algorithmes d'étude, mais c'est une autre bête qui essaie de coder une application de travail complexe qui ne vous donne pas envie de vous arracher les yeux.

D'une certaine manière, écrire du code propre ressemble beaucoup au dessin, à la cuisine ou à la photographie. 5 Loisirs créatifs qui vous rendront plus heureux 5 Loisirs créatifs qui vous rendront plus heureux Une sortie créative appropriée peut faire des merveilles pour votre santé mentale bonheur. Voici quelques passe-temps créatifs qui ont fait leurs preuves dans ce domaine. Lire la suite - il semble plus facile que c'est en réalité. Alors pourquoi s'embêter? Eh bien, parce que les avantages en valent la peine:

  • Les problèmes deviennent plus faciles à résoudre. Une fois que vous commencez à penser en code propre, votre approche de la résolution de problèmes change. Au lieu de solutions de forçage brutal, vos algorithmes et votre conception de logiciel deviennent plus élégants et intentionnels.
  • Moins de temps est gaspillé en maintenance. Le code propre est plus facile à lire et à comprendre, de sorte que vous passez moins de temps à essayer de comprendre ce que certains segments font réellement et plus de temps à réparer, réviser, étendre, etc.
  • Les idées sont plus clairement communiquées. Si vous travaillez avec d'autres programmeurs, le code propre réduit la probabilité de malentendus entre vous tous, ce qui signifie également moins de bogues à long terme.

Voici comment vous pouvez commencer à écrire du code propre.

1. Utilisez des noms descriptifs

Quelles sont les variables, les classes et les fonctions? Il y a plusieurs façons de répondre à cela, mais quand on y pense vraiment, ces choses ne sont rien de plus que l'interface entre un programmeur et la logique sous-jacente d'une application.

Ainsi, lorsque vous utilisez des noms non-clairs et non-descripteurs pour les variables, les classes et les fonctions, vous êtes en train d'obscurcir la logique de l'application de tout programmeur qui lit le code, y compris vous-même.

"Je ne suis pas un excellent programmeur; Je suis juste un bon programmeur avec de grandes habitudes. "
- Kent Beck

Que signifie réellement une variable nommée dxy ? Qui sait. Vous auriez probablement à lire le morceau entier de code pour inverser sa signification. D'un autre côté, la signification d'une variable comme distanceBetweenXY est immédiatement reconnaissable.

La même chose est vraie pour les classes et les fonctions. Ne vous contentez pas de CalcTan() lorsque vous pouvez utiliser CalculateTangent() ou CalcTangentAngle() place.

2. Donnez à chaque classe / fonction un but

Avez-vous déjà jeté un coup d'œil à l'intérieur d'une fonction de centaines ou même de milliers de lignes? Si vous avez, alors vous savez à quel point il peut être difficile de parcourir, comprendre et éditer. Les commentaires peuvent aider mais seulement dans une mesure limitée.

"La programmation brise une grande tâche impossible en plusieurs petites tâches possibles."
- Jazzwant

Le code propre est décomposé en morceaux atomiques. Chaque fonction devrait viser à faire une seule chose et chaque classe devrait viser à représenter un concept particulier. C'est une simplification bien sûr, mais en cas de doute, plus simple est plus propre.

En pratique, un calcul complexe comme GetCreditScore() peut nécessiter d'être décomposé en plusieurs fonctions auxiliaires telles que GetCreditReports(), ApplyCreditHistoryAge() et FilterOutstandingMarks() .

3. Supprimer le code inutile

Cette mauvaise habitude est celle avec laquelle je lutte encore de temps en temps. Cela se passe généralement comme ceci: je veux réparer ou optimiser un morceau de code afin de le commenter et de le réécrire juste en dessous - et même si cela fonctionne, je garde l'ancien code juste au cas où.

"Est-il possible que le logiciel ne ressemble à rien d'autre, qu'il soit destiné à être jeté: que le but soit de toujours le voir comme une bulle de savon?"
- Alan J. Perlis

Au fil du temps, j'ai accumulé un tas de blocs de code commentés qui ne sont plus nécessaires, mais encombrent mes fichiers source. Et la chose amusante est que dans de nombreux cas, le code environnant a évolué de sorte que le code commenté ne fonctionnerait pas même s'il était restauré.

Le fait est que cette pratique de commenter le "code de sauvegarde" a été rendue obsolète par le contrôle de source. Si vous n'utilisez pas quelque chose comme Git ou Mercurial, vous devez commencer à utiliser le contrôle de la source immédiatement. Qu'est-ce que Git & Pourquoi vous devez utiliser le contrôle de version Si vous êtes développeur Qu'est-ce que Git & Pourquoi utiliser le contrôle de version? En tant que développeur web, nous travaillons souvent sur des sites de développement locaux, puis nous téléchargeons tout simplement quand nous avons terminé. C'est bien quand c'est juste vous et les changements sont petits, ... Lire la suite. Un code plus propre vous attend.

4. Lisibilité> Cleverie

Trop de programmeurs confondent "code propre" avec "code intelligent", comme si le compactage de dix lignes en une seule était en quelque sorte plus propre. Bien sûr, cela prend moins de place sur l'écran, mais est-il réellement plus facile à comprendre? Parfois, peut-être. Mais la plupart du temps? Non.

"Tout le monde sait que le débogage est deux fois plus difficile que l'écriture d'un programme en premier lieu. Donc, si vous êtes aussi intelligent que vous pouvez l'être quand vous l'écrivez, comment allez-vous le déboguer? "
- Brian W. Kernighan

Je pense que les programmeurs aiment le code intelligent parce qu'il se sent comme un puzzle ou une énigme résolue. Ils ont trouvé une façon spéciale et unique de mettre en œuvre quelque chose - un raccourci si vous voulez - et cela agit presque comme une validation des compétences du programmeur.

Mais pour écrire du code propre, vous devez laisser votre ego à la porte.

Optimisez toujours le code pour la prochaine personne qui va le lire, parce que selon toute vraisemblance, la prochaine personne sera réellement VOUS et il n'y a rien de plus honteux que d'être incapable de lire ou de comprendre votre propre intelligence.

5. Gardez un style de codage cohérent

Je n'ai rien contre de bons tutoriels de programmation Qu'est-ce qui fait un bon tutoriel de programmation? Qu'est-ce qui fait un bon tutoriel de programmation? Tous les didacticiels de programmation ne sont pas égaux. Certains vous profitent et d'autres finissent par perdre votre temps. Voici ce qu'il faut rechercher dans un didacticiel de programmation de qualité. Lire la suite, mais l'un des inconvénients est que les débutants finissent par prendre une grande variété d'habitudes contradictoires, en particulier en ce qui concerne le style de codage.

Je ne suis pas ici pour déclarer qu'un style est meilleur qu'un autre. Si vous voulez des accolades sur leurs propres lignes, allez-y. Si vous voulez précéder les appels de méthode avec des espaces, c'est bien. Si vous préférez les onglets aux espaces, ne me laissez pas vous convaincre autrement.

Mais quoi que vous fassiez, restez consistant!

Beau est meilleur que laid.
Explicite est mieux qu'implicite.
Simple est meilleur que complexe.
Complexe est mieux que compliqué.
L'appartement est meilleur que l'imbriqué.
Sparse est mieux que dense.
La lisibilité compte.
- Tim Peters, Le zen de Python

Si vous utilisez camelCaseNaming pour les variables, ne le camelCaseNaming pas avec underscore_naming . Si vous utilisez GetThisObject() dans un seul endroit, n'allez pas avec FetchThatObject() ailleurs. Et si vous mélangez des onglets et des espaces, vous méritez d'avoir votre clavier enlevé.

Décidez de ce que vous allez faire dès le départ et respectez-le de bout en bout. Certaines langues, comme Python et C #, ont des guides de style à l'échelle de la langue que vous pourriez vouloir suivre.

6. Choisissez la bonne architecture

Il existe de nombreux paradigmes et architectures différentes que vous pouvez utiliser pour créer vos projets. Notez comment cette astuce consiste à choisir la bonne pour vos besoins, et non à choisir la meilleure . Il n'y a pas de "meilleur" ici.

"Sans exigences et conception, la programmation est l'art d'ajouter des bogues à un fichier texte vide."
- Louis Srygley

Par exemple, le modèle Model-View-Controller (MVC) est très populaire en ce moment dans le développement Web car il permet de garder votre code organisé et conçu de manière à minimiser les efforts de maintenance.

De même, le modèle Entity-Component-System (ECS) est très populaire actuellement dans le développement de jeux car il permet de modulariser les données et la logique du jeu de manière à faciliter l'entretien, tout en produisant du code plus lisible.

7. Maîtriser les idiomes de la langue

Une des difficultés pour maîtriser un nouveau langage de programmation 7 Astuces pour maîtriser un nouveau langage de programmation 7 Astuces utiles pour maîtriser un nouveau langage de programmation Il est normal d'être débordé lorsque vous apprenez à coder. Vous oublierez probablement les choses aussi vite que vous les apprenez. Ces conseils peuvent vous aider à mieux conserver toutes ces nouvelles informations. Read More apprend les nuances qui le séparent de toutes les autres langues. Ces nuances peuvent faire la différence entre un code laid et alambiqué et un code magnifique et facile à entretenir.

Envisagez Python, Java et JavaScript. Ils sont tous extrêmement différents les uns des autres, à un degré qui nécessite une façon de penser différente selon la langue que vous choisissez d'utiliser .

"Un langage qui n'affecte pas la façon dont vous pensez de la programmation ne vaut pas la peine d'être connu."
- Alan J. Perlis

Tandis que Python se concentre sur le code compact et le typage des canards, Java est plutôt du côté de la verbosité et de l'explicitation. Chaque langue a des idiomes (tels que les compréhensions de liste en Python) qui encouragent une certaine manière de coder. Tu ferais bien de les apprendre.

Il y a aussi des «anti-patterns» à s'inquiéter, qui sont essentiellement des modèles de conception sous-optimaux qui aboutissent à un code inefficace, non fiable ou autrement mauvais. Étudier et désapprendre tous les anti-modèles communs liés à votre langue de choix.

8. Étudiez le code des maîtres

Si vous voulez écrire du code propre, la meilleure chose à faire est de voir à quoi ressemble un code propre et d'essayer de comprendre pourquoi c'est ainsi - et il n'y a pas de meilleure façon de faire que d'étudier les fichiers source de l'industrie maîtrise.

Évidemment, vous ne pouvez pas simplement entrer dans le siège de Microsoft et jeter un coup d'œil à leurs projets, mais vous pouvez toujours parcourir des projets open source bien connus Comment afficher et éditer le code source d'une application Open Source Comment afficher et modifier le code source D'une application open-source Si l'open source peut être un bon choix, vous devrez également investir dans la bonne communauté. GitHub est l'un des meilleurs endroits pour le faire, non seulement en raison de la quantité ... En savoir plus. Je ne sais pas par où commencer? Essayez les projets présentés sur Github.

"Tout imbécile peut écrire du code qu'un ordinateur peut comprendre. Les bons programmeurs écrivent du code que les humains peuvent comprendre. "
- Martin Fowler, Refactoring: Améliorer la conception du code existant

Après tout, c'est l'une des raisons pour lesquelles les projets open source existent Pourquoi les gens contribuent-ils aux projets Open Source? Pourquoi les gens contribuent-ils à des projets Open Source? Le développement open source est l'avenir du logiciel. C'est génial pour les utilisateurs parce que les logiciels open source sont généralement disponibles gratuitement et souvent plus sûrs à utiliser. Mais qu'est-ce qui oblige les développeurs à contribuer gratuitement? Lire la suite: afin que les autres puissent apprendre d'eux. Et si vous décidez de contribuer à un tel projet, il peut accélérer le processus d'apprentissage. 5 Idées de projets pour vous aider à apprendre plus rapidement 5 Idées de projets pour vous aider à apprendre plus rapidement Il existe plusieurs moyens de faciliter la programmation. Mettez-vous les mains sales et apprenez plus vite avec des projets secondaires que vous pouvez démarrer à tout moment. Joue avec ces cinq. Lire la suite .

Personnellement, la première fois que j'ai vu du code vraiment propre, c'est quand je suis tombé sur le projet Python open source d'un certain amateur. Le code était tellement élégant que j'ai presque arrêté de programmer, mais ça m'a fini par m'apprendre beaucoup.

9. Écrire de bons commentaires

"Ecrire de bons commentaires" est le plus vieux conseil du monde de la programmation. En fait, dès que les débutants sont introduits dans les commentaires, ils sont plutôt encouragés à faire des commentaires aussi souvent qu'ils le peuvent.

Mais on a presque l'impression d'avoir été trop loin dans la direction opposée. Les débutants, en particulier, ont tendance à faire des commentaires excessifs - décrivant des choses qui n'ont pas besoin d'être décrites et manquant le point de savoir ce qu'est un «bon commentaire».

"Toujours coder comme si le gars qui finit par maintenir votre code sera un psychopathe violent qui sait où vous vivez."
- John Woods

Voici une bonne règle: il existe des commentaires pour expliquer pourquoi un morceau de code existe plutôt que ce que le code fait réellement. Si le code est écrit correctement, il devrait être explicite quant à ce qu'il fait - le commentaire devrait éclairer l'intention derrière la raison pour laquelle il a été écrit.

Les commentaires peuvent être bons pour les avertissements (c.-à-d. «Enlever ceci va casser A, B, et C») mais pour la plupart devraient découvrir des choses qui ne peuvent pas être tirées immédiatement du code (c.-à-d. et Z ").

10. Refactor, Refactor, Refactor

Tout comme l'édition fait partie du processus d'écriture, le refactoring fait partie du processus de codage. Une aversion pour le refactoring est le moyen le plus rapide de se retrouver avec un code non-supportable, donc à bien des égards, c'est le conseil le plus important à prendre en compte.

En bref, refactoring est juste un terme de fantaisie pour nettoyer le code sans affecter son comportement réel.

"Chaque fois que je dois penser à comprendre ce que fait le code, je me demande si je peux refactoriser le code pour rendre cette compréhension plus immédiatement apparente."
- Martin Fowler, Refactoring: Améliorer la conception du code existant

Un bout de la sagesse qui est resté avec moi est le dicton, "Ne commentez pas le mauvais code. Réécrivez-le. »Comme Fowler l'explique dans la citation ci-dessus, si le code est suffisamment confus pour que vous le commentiez, vous devez peut-être le refactoriser.

De plus, lorsque vous modifiez des bits de code ici et là tout au long de votre projet, laissez toujours le code dans un meilleur état que lorsque vous l'avez trouvé pour la première fois . Cela peut sembler une nuisance dans le moment, mais il sera payant sur le long terme (et peut même éviter l'épuisement mental). Programmation Burnout: Comment retrouver votre motivation perdue Programmation Burnout: Comment retrouver votre motivation perdue le code peut être drainant physiquement et émotionnellement.Tout ce dont vous avez besoin pour remonter est la conscience que la motivation peut être récupérée.

Il y a toujours quelque chose de nouveau à apprendre

Un programmeur qui apprend à écrire du code propre s'apparente à un romancier qui apprend à écrire de la prose propre: il n'y a pas de bonne façon de le faire en soi, mais il y a plein de fausses façons de le faire, et ça va prendre années à maîtriser.

Certaines personnes n'ont pas ce qu'il faut et finissent par quitter la programmation pour de bon 6 Signs que vous n'êtes pas censé être un programmeur 6 Signs que vous n'êtes pas censé être un programmeur Tout le monde n'est pas découpé pour être un programmeur. Si vous n'êtes pas complètement sûr que vous êtes destiné à être programmeur, voici quelques signes qui pourraient vous orienter dans la bonne direction. Lire la suite - et c'est bien parce qu'il y a beaucoup d'autres emplois techniques qui n'impliquent pas le codage Codage n'est pas pour tout le monde: 7 emplois Tech que vous pouvez obtenir sans cela Codage n'est pas pour tout le monde: 7 emplois Tech vous pouvez obtenir sans Ne vous découragez pas si vous voulez faire partie du domaine de la technologie - il y a beaucoup d'emplois pour ceux qui ne savent pas coder! Lire la suite .

Mais pour tout le monde, il vaut vraiment la peine d'essayer un code propre, même s'il faut le reste de votre vie pour y arriver.

Quelle est l'importance du code propre pour vous? Quelles règles suivez-vous pour garder votre code propre et organisé? Vous avez d'autres morceaux de sagesse à partager? Faites-nous savoir dans les commentaires ci-dessous!

In this article