Introduction

Si vous êtes ici, c'est sûrement que vous êtes un développeur débutant ou bien même un dev plus experimenté qui cherche à améliorer la qualité de son code. Quoi qu'il en soit, vous êtes au bon endroit car cet article vas justement traiter de ce sujet très important pour tout les devs comme vous et moi.

Il existe différentes méthodes afin de rendre son code plus Professionnel et d'être aussi plus produictif et nous allons aborder tout ces sujets aujourd'hui.

Article

Les règles de lisibilités

L'indentation : Ce point consiste à effectuer des tabulations afin d'identifier les fonction, les sous-balises et les conditions. Ce n'est généralement pas obligatioire pour avoir un code fonctionnel mais c'est recommandé pour que vous et/ou vos collègues puissent s'y retrouver facilement dans votre code.

Les commentaires : Ils ne changent rien au code, mais permettent à vous et votre équipe de pouvoir identifier rapidement une parite du code ayant un problème, même plusieurs mois après. Bien que pratique, il ne faut pas non plus en abuser pour que le code reste propre.

Les noms de variables : Il est important de donner aux variables des noms pertinents et pas trop long afin d'identifier la fonction de la variable rapidement. Surtout ne pas donner de nom génériques comme variable1 ou maVariable mais plus par exemple pour un cout de production coutProduction.
Par ailleurs, les noms de variables ne doivent pas comporter d'accents ni d'espaces ou de caractères spéciaux.
Notez aussi que ces règles s'appliquent aussi aux constantes, aux classes et aux fonctions.

Les conventions de nommage

Il existe énormément de conventions de nommage et chacunes ont leurs utilités. Les conventions de nommage sont très importantes car elles permettent d'avoir une structure standard et propre pour chaque variables, constantes ou fonctions.
Voici les conventions de nommages les plus connu.

• Camel Case : Sans doute l'une des conventions de nommage les plus connu, elle consiste à mettre le premier mot en minuscule et à coller tout les mots en rajoutant une majuscule à chaque mots. Cette méthode est très utilisé pour les variables.
  Exemples : prix, coutProduction, maVitesseMoyenne
• Pascal Case : Lui aussi asser connu, il fonctionne quasiment pareil que le Camel Case mais celui-ci à en plus une majuscule au début. Il peut être utilisé pour des noms de fonctions, de classes ou de consstantes.
  Exemples : Prix, CoutProduction, MaVitesseMoyenne
• Snack Case : Un peu différente des deux premières, cette convention met tout les caractères en minuscule et ajoute des underscores entre chaque mots.
  Exemples : prix, cout_production, ma_vitesse_moyenne
• Kebab Case : Celui-ci, en plus de donner faim, fonctionne presque comme le Snack Case Sauf que au lieu des underscores, celui-ci rajoute des tirets du 6.
  Exemples : prix, cout-production, ma-vitesse-moyenne

Retenez bien que tel ou tel convention n'est pas obligatoire et que vous pouvez utiliser n'importe laquel tant que votre code reste propre et compréhensible pour vous et vos collaborateurs.

Autres conseils

Usage de fonctions : Afin d'optimiser votre code et d'éviter les répétitions, vous pouvez utiliser des fonctions dédié à des taches qui se répetent souvent.

Bonne gestion de l'arborescence de fichiers : L'arborescence de fichier est aussi un point très important pour retrouver facilement un fichier CSS, C# ou même un image ou un fichier audio. Il est important d'avoir une arborescence logique afin de se repérer facilement.

Optimisation de la taille des éléments : Plus un élément est gros, plus il prends de la place dans le stockage et dans la RAM. Et les optimiser peut vraiment faire la différence en terme de performace. Par exemple réduire la taille d'une image trop grande et la convertir en JPEG peut offrir un gain énorme de place et de performance sur un site web. Surtout pour les utilisateurs ayant une connexion à faible débit.

Conclusion

Même si vous ne travaillez pas en équipe, il est important d'appliquer tout ces conseils afin de pouvoir s'y retrouver facilement pluseurs mois après avoir abandonné son code.
Ces conseils sont d'autant plus important si vous travaillé avec une équipe de dev. Cela permettra à votre équipe de comprendre ce que vous avez fait si vous n'êtes pas là pour n'importe quel raison. Si jamais vous n'appliqués pas ces conseils, je pense pas que vous serez le collègue préféré de l'entreprise 😉.

Mon Avis

Ayant déjà un peu d'experience, j'essai moi même de rendre de plus en plus mon code propre, même si ce n'est pas encore parfait.