10 Conseils pour l`écriture plus propre et meilleur code

Sans aucun doute, la programmation est difficile

. Il est une chose à apprendre les langues et l`étude des algorithmes, mais il est un tout autre bête essayant de coder une application de travail complexe qui ne fait pas que vous voulez récupérer vos yeux.Comment apprendre la programmation sans tout le stressComment apprendre la programmation sans tout le stressPeut-ê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 vous commencez à se sentir dépassés. Pas si bien. Voici une aide pour faciliter votre voyage.Lire la suite

Video: (conseil écriture) 10 conseils de base

D`une certaine façon, l`écriture de code propre est un peu comme dessin, cuisine, ou la photographie - il semble plus facile qu`il est en réalité. Alors, pourquoi la peine? Eh bien, parce que les avantages en valent la peine:

• Les problèmes deviennent plus faciles à résoudre. Une fois que vous commencez à penser dans le code propre, votre approche des changements de résolution de problèmes. Au lieu de solutions brutes de forçage, vos algorithmes et la conception de logiciels deviennent plus élégant et intentionnel.
• Moins de perte de temps à l`entretien. Un code propre est plus facile à lire et à comprendre, donc vous passez moins de temps à essayer de comprendre ce que certains segments font réellement et plus de temps sur la fixation, la révision, l`extension, etc.
• Les idées sont plus clairement communiquées. Si vous travaillez avec d`autres programmeurs, code propre réduit la probabilité de malentendus entre vous tous, ce qui signifie aussi moins de bugs à long terme.

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

1. Utiliser des noms descriptifs

Quelles sont les variables, classes et fonctions? Il y a plusieurs façons de répondre à cela, mais quand vous pensez vraiment à ce sujet, 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 peu claires et non-descript pour les variables, les classes et fonctions, vous êtes essentiellement obscurcissant la logique de l`application de tout programmeur qui lit le code, y compris vous.

« Je ne suis pas un grand Programmeur Je suis juste un bon programmeur avec de grandes habitudes. »
- Kent Beck

Qu`est-ce une variable nommée DXY signifie réellement? Qui sait. Vous auriez probablement lire l`intégralité du morceau de code à désosser sa signification. D`autre part, la signification d`un comme la variable distanceBetweenXY est immédiatement reconnaissable.

La même chose est vraie pour les classes et les fonctions. Ne vous contentez pas CalcTan () quand vous pouvez aller CalculateTangent () ou CalcTangentAngle () au lieu.

2. Donner à chaque classe / Fonction One Purpose

Avez-vous déjà jeté un œil à l`intérieur d`une fonction qui a été des centaines, voire des milliers de longues lignes? Si vous avez, alors vous savez combien d`une douleur, il peut être à parcourir, comprendre et modifier. Les commentaires peuvent aider, mais seulement à un degré limité.

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

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

Dans la pratique, un calcul complexe comme GetCreditScore () peut avoir besoin d`être divisé en plusieurs fonctions d`aide comme GetCreditReports (), ApplyCreditHistoryAge (), et FilterOutstandingMarks ().

3. Supprimer le code non nécessaire

Cette mauvaise habitude est une que je lutte toujours avec de temps en temps. Il se produit généralement comme ceci: Je veux corriger ou optimiser un morceau de code, donc je la mettre en commentaire et faire une ré-écriture juste en dessous - et même si cela fonctionne, je garde l`ancien code là juste au cas où.

« Est-il possible que le logiciel ne ressemble à rien d`autre, qu`il est destiné à être mis au rebut: que le tout est de voir toujours comme une bulle de savon »
- Alan J. Perlis

Au fil du temps, j`accumule beaucoup de blocs en commentaire de code qui ne sont encombrent encore plus nécessaires mes fichiers source. Et le plus drôle est que, dans beaucoup de cas, le code a évolué autour de sorte que le code en commentaire ne fonctionnerait pas même si restauré.

La chose est, cette pratique de commenter sur « code de sauvegarde » a été rendu obsolète par le contrôle source. Si vous n`utilisez quelque chose comme Git ou Mercurial, vous devez commencer à utiliser le droit de contrôle source loin. Code Cleaner vous attend.Qu`est-ce que Git & Pourquoi vous devriez utiliser le contrôle de version Si vous êtes un développeurQu`est-ce que Git & Pourquoi vous devriez utiliser le contrôle de version Si vous êtes un développeurEn tant que développeurs web, beaucoup de temps, nous avons tendance à travailler sur les chantiers de développement local, puis il suffit de télécharger tout quand nous aurons terminé. Cela est bien quand il est juste vous et les changements sont petits, ...Lire la suite

4. lisibilité gt; Habileté

Trop de programmeurs amalgament « code propre » avec « le code intelligent », comme si le compactage dix lignes en un seul est en quelque sorte plus propre. Bien sûr, il 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 dur que l`écriture d`un programme en premier lieu. Donc, si vous êtes aussi intelligent que vous pouvez quand vous écrivez, comment allez-vous jamais débugger? »
- Brian W. Kernighan

Je pense que les programmeurs aiment le code intelligent, car il se sent comme un casse-tête résolu ou énigme. Ils ont trouvé une façon particulière et unique de mettre en œuvre quelque chose - un « raccourci » si vous voulez - et il agit presque comme une validation des compétences du programmeur.

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

Code d`optimiser toujours pour la prochaine personne qui va le lire, parce que, selon toute vraisemblance que personne à côté va réellement être 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 uniforme

j`ai rien contre de bons tutoriels de programmation, mais l`un des inconvénients est que les débutants finissent par ramasser une grande variété d`habitudes contradictoires, en particulier en ce qui a trait au style de codage.Qu`est-ce qui fait une bonne programmation tutoriel?Qu`est-ce qui fait une bonne programmation tutoriel?Tous les tutoriels de programmation sont les mêmes. Certains vous bénéficiez et d`autres finissent par perdre votre temps. Voici ce qu`il faut rechercher dans un tutoriel de programmation de qualité.Lire la suite

Je ne suis pas ici pour déclarer qu`un style est mieux 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, très bien. Si vous préférez les onglets pour les espaces, ne me laissez pas vous convaincre du contraire.

Mais quoi que vous fassiez, restez cohérent!

Belle est mieux que laid.
Explicite est mieux que implicite.
Simple est mieux que complexe.
Complexe est mieux que compliquée.
Flat est mieux que imbriquée.
Sparse est mieux que dense.
compte. Lisibilité
- Tim Peters, Le Zen de Python

Si vous allez utiliser camelCaseNaming pour les variables, ne trafiquer pas avec underscore_naming. Si tu utilises GetThisObject () en un seul endroit, ne vont pas FetchThatObject () ailleurs. Et si vous mélangez des onglets et des espaces, vous méritez d`avoir votre clavier enlevé.

Décidez ce que vous allez faire dès le départ et de s`y tenir jusqu`au bout. Certaines langues, comme Python et C #, ont des guides de style langue à l`échelle que vous souhaitez suivre.

6. Choisissez l`architecture droite

Il existe de nombreux paradigmes et architectures différentes que vous pouvez utiliser pour créer vos projets. Notez comment cette astuce est de sélectionner la droite pour vos besoins, et non pas sur le choix du meilleur un là-bas. Il n`y a pas de « meilleur » ici.

« Sans exigences et la conception, la programmation est l`art d`ajouter des bugs dans un fichier texte vide. »
- Louis Srygley

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

Video: [ Conseils d'écriture ] Le flux créatif | Samantha Bailly

De même, le modèle Entité-Component-System (ECS) est très populaire en ce moment dans le développement du jeu, car il aide modularisation données de jeu et la logique d`une manière qui rend l`entretien plus facile, tout en produisant du code qui est plus facile à lire.

7. Maître idiomes de la langue

L`une des difficultés à maîtriser une nouvelle langue de programmation est d`apprendre les nuances qui le séparent de toutes les autres langues. Ces nuances peuvent être la différence entre le code laid, alambiquée et beau, le code facile à entretenir.7 astuces utiles pour maîtriser une nouvelle langue de programmation7 astuces utiles pour maîtriser une nouvelle langue de programmationIl est normal d`être dépassés lorsque vous apprenez à code. Vous aurez probablement oublier les choses aussi vite que vous les apprendre. Ces conseils peuvent vous aider à mieux conserver toutes ces informations nouvelles.Lire la suite

Considérez Python, Java et javascript. Ils sont tous très différents les uns des autres, à un degré qui exige autre façon de penser en fonction de la langue que vous choisissez d`utiliser.

« Une langue qui ne touche pas la façon dont vous pensez à la programmation ne vaut pas le savoir. »
- Alan J. Perlis

Alors que Python est tout code compact et frappe de canard, Java est plus vers le côté de verbosité et explicitation. Chaque langue a idiomes (comme compréhensions liste en Python) qui encouragent une certaine façon de coder. Vous feriez bien de les apprendre.

Il y a aussi des « anti-modèles » à se soucier, qui sont essentiellement des modèles de conception des sous-optimales qui se traduisent par un code inefficace, peu fiable, ou autre mauvais. Etude et désapprendre tous les anti-modèles communs liés à la langue de votre choix.

8. Etude Code des Maîtres

Si vous voulez écrire un code propre, la meilleure chose que vous pouvez faire est de voir ce code propre ressemble et essayer de comprendre pourquoi il est la façon dont il est - et il n`y a pas de meilleure façon de le faire que par l`étude des fichiers source de l`industrie maîtrise.

De toute évidence, vous ne pouvez pas sauter dans le siège de Microsoft et coup d`oeil à leurs projets, mais vous pouvez toujours parcourir les projets open source bien connue. Je ne sais pas où commencer? Essayez les projets présentés sur Github.Comment Voir & Modifier le code source d`une application Open SourceComment Voir & Modifier le code source d`une application Open SourceEn allant open source pourrait être un bon choix, vous aurez également besoin d`investir dans la bonne communauté. GitHub est l`un des meilleurs endroits pour le faire, non seulement à cause de la quantité pure ...Lire la suite

« Tout fou peut écrire du code qu`un ordinateur peut comprendre. Les bons programmeurs d`écrire du code que les humains peuvent comprendre « .
- Martin Fowler, Refactoring: Améliorer la conception du EXISTANT

Après tout, c`est l`une des raisons pourquoi les projets open source existent: Pour que les autres peuvent apprendre d`eux. Et si vous décidez de contribuer à un tel projet, il peut accélérer le processus d`apprentissage.

Personnellement, la première fois que je voyais vraiment un code propre est quand je suis tombé sur le projet Python open source d`un certain bricoleur. Le code était si écrasante que je élégant quitter presque la programmation, mais il a fini par me enseigner beaucoup.

9. Ecrire Bon Commentaires

« Ecrire de bons commentaires » est le plus ancien conseil dans le monde de la programmation. En fait, dès que les débutants sont initiés aux commentaires, ils sont à peu près encouragés à commenter aussi souvent que possible.

Mais il se sent presque comme si nous avons balancé trop loin dans le sens opposé. Newbies, en particulier, ont tendance à trop commentaire - décrire les choses qui ne ont pas besoin d`être décrit et manque le point de ce qu`est un « bon commentaire » est en réalité.

« Toujours le code comme si le gars qui finit par le maintien de votre code sera un psychopathe violent qui sait où vous vivez. »
- John Woods

Voici une bonne règle: les commentaires existent pour expliquer pourquoi un morceau de code existe plutôt que ce que le code ne fait. Si le code est écrit assez proprement, il devrait être explicite à ce qu`il fait - le commentaire doit faire la lumière sur l`intention derrière la raison pour laquelle il a été écrit.

Les commentaires peuvent être bon pour les avertissements (ie « suppression de cette brisera A, B et C »), mais pour la plupart devraient découvrir des choses qui ne peuvent pas être immédiatement glanées à partir du code ( « utiliser ce paramètre parce que X, Y, et Z »).

10. Refactor, Refactor, Refactor

Tout comme l`édition fait partie du processus d`écriture, refactoring fait partie du processus de codage. Une aversion pour refactoring est le moyen le plus rapide pour finir avec le code ingérable, donc à bien des égards c`est en fait le conseil le plus important à considérer.

En bref, la refactorisation est juste un terme de fantaisie pour le nettoyage du code sans impact sur son comportement réel.

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

Un peu de sagesse qui a collé avec moi est le dicton: « Ne pas faire de commentaires mauvais code. Réécrivez. » Comme Fowler explique dans la citation ci-dessus, si le code se sent jamais assez déroutant que vous avez besoin de commenter, peut-être que vous avez réellement besoin de refactoriser.

De plus, comme vous ici et là éditer des morceaux de code tout au long de votre projet, toujours laisser le code dans un meilleur état que lorsque vous avez trouvé. Il peut sembler une nuisance dans le moment, mais il sera rentable à long terme (et peut même éviter l`épuisement mental).Programmation Burnout: Comment Regagnez votre motivation perduProgrammation Burnout: Comment Regagnez votre motivation perduÉcrit toutes ces lignes de code peut être épuisant physiquement et émotionnellement. Tout ce que vous avez besoin de se relever est la prise de conscience que la motivation peut être récupérée.Lire la suite

Video: 1 conseil pour écrire rapidement

Il y a toujours quelque chose à apprendre

Un programmeur qui apprend comment écrire un code propre est semblable à un romancier d`apprendre à écrire de la prose propre: il n`y a pas une bonne façon de le faire en tant que tel, mais il y a beaucoup de mauvaises façons de le faire, et ça va prendre des années à maîtriser.

Certaines personnes ne sont pas ce qu`il faut et éventuellement finir par quitter la programmation pour le bien - et c`est bien parce qu`il ya beaucoup de d`autres emplois techy qui ne nécessitent pas de codage.6 signes que vous n`êtes pas censé être un programmeur6 signes que vous n`êtes pas censé être un programmeurPas tout le monde est découpé pour être un programmeur. Si vous n`êtes pas complètement sûr que vous êtes censé être un programmeur, voici quelques signes qui peuvent vous pointer dans la bonne direction.Lire la suite

Mais pour tout le monde, code propre est quelque chose qui est absolument tendre vers une valeur, même si elle prend le reste de votre vie pour y arriver.

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