L’écriture d’un code propre et maintenable est essentielle à tout projet de production. Et pourtant, même le code le plus fonctionnel est mal vu s’il ne respecte pas les normes de codage fixées par une entreprise. Un bon ingénieur sait que tout changement important doit passer par une révision du code avant d’être fusionné dans la ligne principale. Pourtant, les commentaires les plus fréquents formulés dans ce type d’avis concernent souvent des violations de normes de codage (et non de fonctionnalités). Alors pourquoi nous soucions-nous autant des normes de codage ? Les gens débattent-ils vraiment des tabulations par rapport aux espaces ?
Pourquoi une norme de codage est-elle importante ?
- Cela crée une apparence cohérente sur l’ensemble de la base de code.
- Permet aux lecteurs de comprendre le code plus rapidement.
- Plus facile de maintenir la base de code lors des fusions.
- Il est plus facile de vérifier les meilleures pratiques suivantes.
La plupart du temps, lorsqu’ils travaillent dans une entreprise, ils disposent déjà d’une norme de codage, à condition qu’elle soit rédigée, espérons-le, d’une manière facile à comprendre. Mais disons que vous démarrez un projet favori que vous envisagez d’ouvrir à la communauté en open source. Quelle norme suivez-vous et comment la communiquez-vous aux personnes qui, espérons-le, y contribueront ? Eh bien, vous n’êtes pas obligé de réinventer la roue. Il existe de nombreuses normes de codage prédéfinies. Voici une liste de quelques-uns des bons que j’ai trouvés :
Je n’ai vraiment qu’un seul conseil pour vous aider à suivre un guide de style. Rendre impossible l’échec. Configurez votre IDE pour qu’il vous crie dessus à chaque fois qu’il trouve quelque chose qui viole la norme. Est-ce très ennuyeux lorsque vous essayez simplement de faire fonctionner le code ? Absolument, mais c’est aussi la seule façon d’apprendre à se conformer à la norme. De plus, certaines règles sont ennuyeuses.
Suivez ce tutoriel pour savoir comment ajouter votre norme de codage à votre IDE
Conseil de pro : la plupart des normes définissent un nombre maximum de caractères par ligne. Configurez votre éditeur pour afficher une ligne verticale à cette marque, comme la ligne à droite dans la capture d’écran ci-dessous :
La réponse est les espaces. Pourquoi? Parce que…. C’est juste. Honnêtement, je suis d’accord avec l’un ou l’autre. Ne mélangez jamais les deux. Être cohérent.
