Bienvenue dans le monde merveilleux du développement logiciel. Préparez-vous à un voyage excitant et palpitant rempli de code, de règles et de plus de code. Et ai-je mentionné qu’il y a des règles ? Si vous êtes quelqu’un qui est familier avec le codage, alors le concept de normes de codage n’est pas nouveau pour vous. Vous êtes peut-être un fervent partisan de ces directives ou un combattant de la liberté qui croit que le code est une forme d’expression. Quel que soit le cas, cela ne fait pas de mal d’examiner certaines des meilleures pratiques lorsqu’il s’agit d’écrire un bon morceau de code.
Il convient de mentionner que si les normes de codage existent – elles existent dans de nombreuses variations et sont souvent de simples lignes directrices qui n’ont pas à être suivies. À moins que vous ne vouliez écrire un bon code, alors vous devriez probablement vous en tenir à une certaine forme de normes.
- Écrire des commentaires et de la documentation
- Écrire un code lisible mais efficace
- Utiliser des méthodes d’aide
- Si cela est évitable, ne codez PAS en dur !
- Ecrivez des cas de test. N’oubliez pas les cas limites : Les 0, les chaînes/listes vides, les nuls, etc.
- Écrire un code lisible mais efficace.Se conformer aux normes de codage de votre projet actuel
- Utilisez le menu déroulant de votre IDE
- Les API sont pratiques
- Programmation par paires/examen du code
- SUPPRIMER ET SAUVEGARDER VOTRE TRAVAIL SOUVENT
- À propos de l’auteur
Écrire des commentaires et de la documentation
Peut-être l’une des premières choses que vous apprenez en tant que développeur est de commenter votre code. Au début, cela peut sembler être une perte de temps, suivant la mentalité de ‘Si eux aussi sont des développeurs – ils peuvent le comprendre’. Bien que cela soit vrai dans certains cas, commenter votre code et fournir une documentation appropriée guidera les autres développeurs à travers l’algorithme et la logique que vous avez mis en œuvre. Mais ne vous laissez pas emporter et commentez chaque ligne de code ! Le code évident devrait être laissé tel quel.
Écrire un code lisible mais efficace
Les codes lisibles sont faciles à suivre, tout en utilisant un espace et un temps optimaux. Lorsque vous écrivez du code, vous pouvez souvent vouloir l’écrire en aussi peu de lignes que possible. Peut-être pouvez-vous écrire une méthode ou une fonction entière en une seule ligne, mais cela ne fait que le rendre plus difficile à lire et à comprendre.
Utiliser des méthodes d’aide
C’est une bonne pratique de garder le code concis et succinct. Une méthode ne doit implémenter que ce qu’elle doit faire. Si une partie de votre implémentation fait quelque chose d’autre, mettez-la dans une méthode séparée et appelez-la dans votre méthode.
Si cela est évitable, ne codez PAS en dur !
Les seules choses qui devraient être codées en dur sont les constantes. C’est tout.
Ecrivez des cas de test. N’oubliez pas les cas limites : Les 0, les chaînes/listes vides, les nuls, etc.
De cette façon, vous savez ce que votre méthode fait, ce qu’elle prend et ce qu’elle devrait retourner. Vous saurez quand elle doit fonctionner ou quand elle doit échouer. Une fonction devrait toujours être basée sur des cas de test ; pas des tests sur des fonctions.
Écrire un code lisible mais efficace.Se conformer aux normes de codage de votre projet actuel
« DES PRATIQUES PERSONNELLES DISCIPLINÉES PEUVENT RÉDUIRE LES TAUX D’INTRODUCTION DE DÉFAUTS DE 75 POURCENT »
Chaque projet/entreprise a ses propres normes de codage. Certains pourraient préférer un style plutôt qu’un autre lorsqu’il s’agit de choses comme les conventions de nommage, la structure des fichiers et l’espacement.
Il existe des IDE où vous pouvez définir le style préféré, qui vous corrigera automatiquement lorsque vous enregistrez. Il est plus facile de lire et, donc de comprendre, lorsque tous les fichiers des projets utilisent le même style, la même convention de nommage, l’espacement, etc.
Pas vraiment une norme, mais une bonne pratique, celles-ci sont très utiles et vous aideront à faire moins d’erreurs de codage.
Par exemple :
Si vous voulez renommer une variable ou une méthode, utilisez simplement l’option « refactor » de votre IDE et il changera tous les appels à ce nom de méthode/variable. Vous n’avez pas à les changer un par un, ce qui rendra votre code sujet aux erreurs/échecs.
Si vous voulez créer des méthodes getter/setter de toutes vos variables privées, utilisez simplement « create getter/setter » et l’IDE créera automatiquement les méthodes pour vous.
Les API sont pratiques
Avant d’implémenter une méthode, assurez-vous qu’ils ne sont pas disponibles pour que vous les utilisiez. Vous n’avez pas besoin de coder si vous pouvez simplement importer la fonctionnalité. Cela rend la vie d’un développeur super facile.
Le célèbre dicton est « Ne réinventez pas la roue » et il est vrai dans de nombreux cas. Cependant, vous devriez toujours considérer les implications de l’importation d’une bibliothèque, surtout si elle est tierce. Outre les éventuels problèmes de licence, vous risquez d’alourdir votre base de code. Si tout ce dont vous avez besoin est une méthode qui convertit les températures, vous n’avez pas besoin d’importer une bibliothèque qui fait cela et une centaine d’autres choses.
Programmation par paires/examen du code
Ces derniers sont très utiles lorsqu’il s’agit de refactorer votre code. D’autres pourraient voir une meilleure mise en œuvre pour optimiser votre code ou simplement rendre votre code plus élégant. Cela permet également de s’assurer que les développeurs respectent les normes et que le travail est doublement vérifié. En plus de tout cela, c’est une merveilleuse façon pour les développeurs d’apprendre les uns des autres.
SUPPRIMER ET SAUVEGARDER VOTRE TRAVAIL SOUVENT
Assez dit. Une batterie morte, une panne de courant, un pépin logiciel, un incendie, une catastrophe nucléaire, tous ces éléments peuvent entraîner une perte de données. S’assurer que vous sauvegardez souvent et que vous sauvegardez votre code sur une sorte de système de contrôle de version est un moyen simple de s’assurer que votre code reste en sécurité.
Les normes de codage et les meilleures pratiques sont un sujet énorme – un qui peut continuer pendant de nombreuses pages. En fait, si vous souhaitez un jour vous documenter sur les normes de codage Java, Oracle vous propose justement de le faire. L’application de ces normes et pratiques varie également selon l’application – que vous travailliez sur un énorme projet d’entreprise ou que vous aidiez votre petit frère à faire ses devoirs. En fonction de nombreux facteurs, c’est finalement à vous de vous assurer que le code que vous développez est un bon code.
À propos de l’auteur
Denis Kharlamov est un développeur de logiciels chez Aversan. Il travaille dans un domaine de la santé électronique depuis près de deux ans, effectuant des tests et des vérifications de logiciels. En dehors d’Aversan, Denis apprécie une variété d’activités différentes telles que la randonnée, la natation, la conception et le développement de logiciels & web, jouer à des jeux vidéo et bien sûr dormir.
Disclaimer : Tous les points de vue ou opinions présentés dans cet article de blog sont uniquement ceux de l’auteur et ne représentent pas nécessairement ceux d’Aversan Inc.
.