Bonjour à tous, communauté JavaRush ! Aujourd'hui, nous parlerons de la qualité du code. Oui, oui, chers amis. Personne n'est parfait. Tout le monde comprend un jour que le code pourrait être meilleur... Mais que faire dans cette situation ? À tout le moins, commencez à faire des recherches sur ce problème. Puisque vous êtes là, c'est que le sujet vous intéresse, alors c'est parti. Aujourd'hui, nous allons décrire les moyens par lesquels vous pouvez améliorer et rendre votre code plus propre. Pour qu'à l'avenir vous n'ayez pas honte de votre code actuel !..)) Toutes ces méthodes aideront le programmeur à devenir un bon programmeur.
1. Si vous souhaitez améliorer votre code, lisez le code de quelqu'un d'autre
Si vous souhaitez améliorer considérablement vos compétences en programmation, vous devez... lire le code écrit par d'autres programmeurs. Vous pouvez y croire, vous ne pouvez pas y croire. Mais si vous prenez le risque, je vous promets que votre temps sera récompensé. Par exemple, ne lisez pas sur Habré comment fonctionnent HashMap, ArrayList, LinkedList, etc., mais lisez leur code et découvrez-le vous-même. Voici une liste de cours à lire :
HashMap est la question la plus fréquemment posée lors des entretiens. Vous pouvez faire d’une pierre plusieurs coups : comprendre le code et obtenir les connaissances nécessaires.
ArrayList est le même cas qu'avec HashMap. Il n’y a pas de choses compliquées là-bas, mais cela vaut vraiment la peine d’être lu et compris.
La chaîne est un excellent exemple. Comprenez pourquoi il est immuable.
AtomicInteger est une classe intéressante : elle décrit le processus permettant d'effectuer atomiquement des opérations sur des objets Integer.
Et puis - au moins tous les cours d'affilée...)
Si nous parlons de quelque chose de plus sérieux, bien sûr, cela vaut la peine de lire le code de Pivotal. Ces gars-là ont écrit l'écosystème le plus recherché du monde Java. Leur code vaut vraiment la peine d'être lu. Par conséquent, je vous conseille de commencer par Spring Core . Lire un code source inconnu est un travail difficile mais très gratifiant.)
2. Suivez les conventions de code - conventions d'écriture de code
Les conventions de codage sont un ensemble de lignes directrices élaborées par des équipes de développement qui incluent des lignes directrices sur le style et les techniques de programmation pour chaque aspect du code écrit au sein d'une entreprise ou d'un projet spécifique. Ces conventions sont généralement spécifiques à chaque langage de programmation et couvrent l'organisation des fichiers, l'indentation, les commentaires, les déclarations, les opérateurs, les espaces, les conventions de dénomination, les techniques et principes de programmation, les règles de programmation, les meilleures pratiques architecturales, etc. Le principal avantage de certaines normes est que cela le code est identique et est écrit dans le même style. Cela le rend plus lisible et aide les programmeurs à comprendre le code écrit par un autre programmeur. Si les normes de codage sont suivies et appliquées de manière cohérente tout au long du processus de développement, il sera plus facile de maintenir et d'étendre le code, de le refactoriser et de résoudre les conflits d'intégration à l'avenir. Les conventions de codage sont importantes pour les programmeurs pour plusieurs raisons :
40 à 80 % du coût du logiciel est consacré à sa maintenance ;
pratiquement aucun logiciel n'est maintenu par l'auteur tout au long de sa vie ;
Les conventions de code améliorent la lisibilité des logiciels, permettant aux programmeurs de comprendre plus rapidement le nouveau code.
Pour être honnête, je suis un grand fan des normes de codage. Pour moi, il est logique de passer du temps à en discuter et à en discuter, car c'est une activité précieuse qui vous fera gagner du temps et des efforts à l'avenir. Les conventions du Code doivent être révisées fréquemment. Les règles peuvent être traduites de « obligatoire » à « facultatif » et vice versa. Si certains d’entre eux ne fonctionnent pas correctement, ils doivent être repensés ou supprimés des lignes directrices.
3. Utiliser la révision du code - révision du code par d'autres
La révision du code est l’un des outils les plus puissants pour améliorer le code. Pourquoi? Parce que le code sera examiné par les spécialistes qui ne l'ont pas écrit. Et un nouveau regard est très utile. Et souvent, c'est la révision du code qui permet d'éviter l'écriture d'un code franchement terrible. Je sais que ce n’est pas toujours possible, car il faut trouver une autre personne qui voudrait le faire. Mais cela ne veut pas dire que cet outil ne vaut pas la peine d’être utilisé. Bien au contraire : c'est une raison pour trouver des personnes partageant les mêmes idées pour lesquelles il est également important d'améliorer la qualité du code. Au fait, qui vous interdit de les trouver ici sur JavaRush ? Dans un endroit où tout le monde veut devenir programmeur.
4. Écrire des tests unitaires - tests unitaires
Ma méthode préférée pour améliorer le code consiste de loin à écrire des tests unitaires. De plus, plus vous les écrivez, mieux c'est. En programmation informatique, les tests unitaires sont un processus de développement logiciel dans lequel la plus petite partie testable du code source, appelée unité, est testée individuellement et indépendamment pour vérifier si elle fonctionne comme prévu. Cela vous aidera à identifier les échecs des algorithmes et/ou de la logique avant de publier le code. Étant donné que les tests unitaires nécessitent une structure appropriée de votre code, cela signifie que le code doit être divisé en fonctions plus petites et plus ciblées. Chacun d'eux est responsable d'une seule opération sur un ensemble de données, plutôt que de grandes fonctions effectuant un certain nombre d'opérations différentes. (Comme on dit, bonjour du principe de responsabilité unique ...) Le deuxième avantage d'écrire du code bien testé est que vous pouvez éviter de futurs échecs suite à de petites modifications apportées à la fonctionnalité de rupture de code existante. Lorsqu'un échec se produit, les tests unitaires vous indiqueront que quelque chose n'a pas été écrit correctement. À première vue, passer du temps à écrire des tests unitaires pendant le développement semble être une dépense supplémentaire. Cependant, cela permettra de gagner du temps à l'avenir, qui devra être consacré au débogage. Cela devrait être un processus étape par étape. Alors allez-y et chantez - écrivez des tests pour toutes les méthodes et classes :D
5. Utiliser des outils pour améliorer la qualité du code
Il n’existe aucun développeur qui ne commette jamais d’erreurs. Généralement, le compilateur détecte les problèmes de syntaxe et d'arithmétique et génère une trace de pile. Mais il peut encore y avoir des problèmes que le compilateur ne détecte pas. Par exemple, des exigences mal mises en œuvre, des algorithmes incorrects, une structure de code incorrecte ou certains problèmes potentiels connus de la communauté par expérience. La seule façon de détecter de telles erreurs est de demander à un développeur senior de revoir votre code. Cette approche n’est pas une panacée et change peu. Avec chaque nouveau développeur dans l’équipe, vous devriez avoir une paire d’yeux supplémentaire pour examiner son code. Mais heureusement, il existe de nombreux outils qui peuvent vous aider à contrôler la qualité de votre code. J'ai utilisé Checkstyle, PMD, FindBugs, SonarQube dans mon travail sur divers projets. Il y en a d'autres aussi. Tous sont couramment utilisés pour l’analyse de la qualité et pour générer des rapports utiles. Très souvent ces rapports sont publiés par des serveurs d'intégration continue tels que Jenkins.
6. Écrivez du code simple et clair
Écrivez toujours un code simple, clair et logique. Les gens ont tendance à écrire du code complexe pour prouver leur capacité à le faire. Un code simple mais logique fonctionne toujours bien, entraîne moins de problèmes et est plus extensible. Un bon code signifie une meilleure documentation. Si vous envisagez d'ajouter un commentaire, demandez-vous : « Comment puis-je améliorer le code pour que ce commentaire ne soit pas nécessaire ? " ~Steve McConnell.
7. Lisez la documentation
L’une des habitudes importantes des bons programmeurs est de lire beaucoup de documentation. Qu'il s'agisse de spécifications, de JSR, de documents API, de didacticiels, etc. La lecture de documents vous aide à construire cette base solide sur laquelle vous programmez le mieux. Enfin et surtout, ne vous comparez pas aux autres, car vous comparer aux autres ne fera qu'engendrer des sentiments négatifs et une compétition malsaine. Chacun a ses propres forces et faiblesses. Il est donc important de les connaître et de travailler avec eux. Analysez-vous, listez vos points forts et travaillez dessus. La programmation est vraiment amusante : profitez-en.
« La constante d’un homme est la variable d’un autre. »
8. Suivez des blogueurs intéressants
Des milliers de passionnés à travers le monde travaillent et écrivent sur les mêmes technologies. Les blogs sont souvent rédigés par les programmeurs eux-mêmes et la plupart d'entre eux partagent des opinions et des expériences personnelles. Vous pouvez voir différentes perspectives d’une même technologie sur les blogs. Vous pouvez voir à la fois de la bonne et de la mauvaise technologie sur les blogs. Au minimum, lisez les articles sur Habré JavaRush :D, y compris le mien. Suivez les bons blogs et commentez les articles, partagez votre opinion.
9. Lire des livres spécialisés
Rien ne remplace un bon livre. Un bon livre enseignera les concepts de base d’une manière beaucoup plus simple et s’appliquera aux objets du monde réel. Leurs auteurs sont eux-mêmes de grands programmeurs. En lisant des livres, vous pouvez apprendre des expériences des autres. Je suggère de lire « Java. Programmation efficace par Joshua Bloch. Ce livre présente soixante-dix-huit règles empiriques irremplaçables pour les programmeurs : les meilleures solutions efficaces aux problèmes de programmation auxquels vous êtes confrontés quotidiennement. Il contient les directives les plus pratiques et faisant autorité que vous pouvez utiliser pour rédiger des programmes efficaces et bien conçus. Si vous débutez avec Java et n'avez aucune expérience en programmation, vous pouvez lire le livre « Sams Teach Yourself Java 2 in 24 Hours ». Et pour écrire du code propre, il existe un excellent livre « Clean Code de Robert Martin ». Après cela, un « sentiment de beauté » apparaîtra par rapport au code.
10. Codez ! Code! Code!
Vous ne pouvez pas devenir un bon programmeur simplement en mémorisant un livre. Il est facile de parler de concepts théoriques. Mais vous ne pouvez connaître les limites du langage ou développer de bonnes pratiques que lorsque vous écrivez du code. Par conséquent, pour devenir un bon programmeur, vous devez écrire beaucoup de code. Si vous êtes débutant, commencez par écrire des programmes pour des problèmes simples comme les séries de Fibonacci, le palindrome, le triangle de Pascal, etc., puis passez à des problèmes plus vastes comme l'arbre de recherche binaire, etc. Si vous recherchez une plateforme en ligne pour pratiquer les programmes Java, jetez un oeil à Coding Ground . D'ailleurs, vous pouvez suivre le cours CS50 dont la traduction nous a été fournie par « vous savez qui » :D
Résumons-le
Celui qui ne fait rien ne fait aucune erreur. Par conséquent, nous devons être patients et, comme un Japonais travailleur, perfectionner nos compétences en matière de codage. Pour cela, n'oubliez pas :
Si vous souhaitez améliorer considérablement vos compétences en programmation, vous devez... lire le code écrit par d'autres programmeurs. Vous pouvez y croire, vous ne pouvez pas y croire. Mais si vous prenez le risque, je vous promets que votre temps sera récompensé. Par exemple, ne lisez pas sur Habré comment fonctionnent HashMap, ArrayList, LinkedList, etc., mais lisez leur code et découvrez-le vous-même. Voici une liste de cours à lire :
Les conventions de codage sont un ensemble de lignes directrices élaborées par des équipes de développement qui incluent des lignes directrices sur le style et les techniques de programmation pour chaque aspect du code écrit au sein d'une entreprise ou d'un projet spécifique. Ces conventions sont généralement spécifiques à chaque langage de programmation et couvrent l'organisation des fichiers, l'indentation, les commentaires, les déclarations, les opérateurs, les espaces, les conventions de dénomination, les techniques et principes de programmation, les règles de programmation, les meilleures pratiques architecturales, etc. Le principal avantage de certaines normes est que cela le code est identique et est écrit dans le même style. Cela le rend plus lisible et aide les programmeurs à comprendre le code écrit par un autre programmeur. Si les normes de codage sont suivies et appliquées de manière cohérente tout au long du processus de développement, il sera plus facile de maintenir et d'étendre le code, de le refactoriser et de résoudre les conflits d'intégration à l'avenir. Les conventions de codage sont importantes pour les programmeurs pour plusieurs raisons :
Pourquoi? Parce que le code sera examiné par les spécialistes qui ne l'ont pas écrit. Et un nouveau regard est très utile. Et souvent, c'est la révision du code qui permet d'éviter l'écriture d'un code franchement terrible. Je sais que ce n’est pas toujours possible, car il faut trouver une autre personne qui voudrait le faire. Mais cela ne veut pas dire que cet outil ne vaut pas la peine d’être utilisé. Bien au contraire : c'est une raison pour trouver des personnes partageant les mêmes idées pour lesquelles il est également important d'améliorer la qualité du code. Au fait, qui vous interdit de les trouver ici sur JavaRush ? Dans un endroit où tout le monde veut devenir programmeur.
Ma méthode préférée pour améliorer le code consiste de loin à écrire des tests unitaires. De plus, plus vous les écrivez, mieux c'est. En programmation informatique, les tests unitaires sont un processus de développement logiciel dans lequel la plus petite partie testable du code source, appelée unité, est testée individuellement et indépendamment pour vérifier si elle fonctionne comme prévu. Cela vous aidera à identifier les échecs des algorithmes et/ou de la logique avant de publier le code. Étant donné que les tests unitaires nécessitent une structure appropriée de votre code, cela signifie que le code doit être divisé en fonctions plus petites et plus ciblées. Chacun d'eux est responsable d'une seule opération sur un ensemble de données, plutôt que de grandes fonctions effectuant un certain nombre d'opérations différentes. (Comme on dit, bonjour du principe de responsabilité unique ...) Le deuxième avantage d'écrire du code bien testé est que vous pouvez éviter de futurs échecs suite à de petites modifications apportées à la fonctionnalité de rupture de code existante. Lorsqu'un échec se produit, les tests unitaires vous indiqueront que quelque chose n'a pas été écrit correctement. À première vue, passer du temps à écrire des tests unitaires pendant le développement semble être une dépense supplémentaire. Cependant, cela permettra de gagner du temps à l'avenir, qui devra être consacré au débogage. Cela devrait être un processus étape par étape. Alors allez-y et chantez - écrivez des tests pour toutes les méthodes et classes :D
Il n’existe aucun développeur qui ne commette jamais d’erreurs. Généralement, le compilateur détecte les problèmes de syntaxe et d'arithmétique et génère une trace de pile. Mais il peut encore y avoir des problèmes que le compilateur ne détecte pas. Par exemple, des exigences mal mises en œuvre, des algorithmes incorrects, une structure de code incorrecte ou certains problèmes potentiels connus de la communauté par expérience. La seule façon de détecter de telles erreurs est de demander à un développeur senior de revoir votre code. Cette approche n’est pas une panacée et change peu. Avec chaque nouveau développeur dans l’équipe, vous devriez avoir une paire d’yeux supplémentaire pour examiner son code. Mais heureusement, il existe de nombreux outils qui peuvent vous aider à contrôler la qualité de votre code. J'ai utilisé Checkstyle, PMD, FindBugs, SonarQube dans mon travail sur divers projets. Il y en a d'autres aussi. Tous sont couramment utilisés pour l’analyse de la qualité et pour générer des rapports utiles. Très souvent ces rapports sont publiés par des serveurs d'intégration continue tels que Jenkins.
Écrivez toujours un code simple, clair et logique. Les gens ont tendance à écrire du code complexe pour prouver leur capacité à le faire. Un code simple mais logique fonctionne toujours bien, entraîne moins de problèmes et est plus extensible. Un bon code signifie une meilleure documentation. Si vous envisagez d'ajouter un commentaire, demandez-vous : « Comment puis-je améliorer le code pour que ce commentaire ne soit pas nécessaire ? " ~Steve McConnell.
L’une des habitudes importantes des bons programmeurs est de lire beaucoup de documentation. Qu'il s'agisse de spécifications, de JSR, de documents API, de didacticiels, etc. La lecture de documents vous aide à construire cette base solide sur laquelle vous programmez le mieux. Enfin et surtout, ne vous comparez pas aux autres, car vous comparer aux autres ne fera qu'engendrer des sentiments négatifs et une compétition malsaine. Chacun a ses propres forces et faiblesses. Il est donc important de les connaître et de travailler avec eux. Analysez-vous, listez vos points forts et travaillez dessus. La programmation est vraiment amusante : profitez-en.
Des milliers de passionnés à travers le monde travaillent et écrivent sur les mêmes technologies. Les blogs sont souvent rédigés par les programmeurs eux-mêmes et la plupart d'entre eux partagent des opinions et des expériences personnelles. Vous pouvez voir différentes perspectives d’une même technologie sur les blogs. Vous pouvez voir à la fois de la bonne et de la mauvaise technologie sur les blogs. Au minimum, lisez les articles sur 
Rien ne remplace un bon livre. Un bon livre enseignera les concepts de base d’une manière beaucoup plus simple et s’appliquera aux objets du monde réel. Leurs auteurs sont eux-mêmes de grands programmeurs. En lisant des livres, vous pouvez apprendre des expériences des autres. Je suggère de lire « Java. Programmation efficace par Joshua Bloch. Ce livre présente soixante-dix-huit règles empiriques irremplaçables pour les programmeurs : les meilleures solutions efficaces aux problèmes de programmation auxquels vous êtes confrontés quotidiennement. Il contient les directives les plus pratiques et faisant autorité que vous pouvez utiliser pour rédiger des programmes efficaces et bien conçus. Si vous débutez avec Java et n'avez aucune expérience en programmation, vous pouvez lire le livre « Sams Teach Yourself Java 2 in 24 Hours ». Et pour écrire du code propre, il existe un excellent livre « Clean Code de Robert Martin ». Après cela, un « sentiment de beauté » apparaîtra par rapport au code.
Il est facile de parler de concepts théoriques. Mais vous ne pouvez connaître les limites du langage ou développer de bonnes pratiques que lorsque vous écrivez du code. Par conséquent, pour devenir un bon programmeur, vous devez écrire beaucoup de code. Si vous êtes débutant, commencez par écrire des programmes pour des problèmes simples comme les séries de Fibonacci, le palindrome, le triangle de Pascal, etc., puis passez à des problèmes plus vastes comme l'arbre de recherche binaire, etc. Si vous recherchez une plateforme en ligne pour pratiquer les programmes Java, jetez un oeil à Coding Ground . D'ailleurs, vous pouvez suivre le cours CS50 dont la traduction nous a été fournie par « vous savez qui » :D
GO TO FULL VERSION