|
différents types de styles de codage dans l'ingénierie logicielle
Le style de codage, également connu sous le nom de conventions de codage, est un ensemble de directives qui dictent comment les programmeurs devraient écrire du code. Il vise à améliorer la lisibilité, la maintenabilité et la cohérence du code dans un projet. Voici différents types de styles de codage:
1. Indentation:
* Espaces vs onglets: L'un des débats les plus fondamentaux. Certains préfèrent utiliser des espaces pour l'indentation, d'autres préfèrent les onglets. La cohérence dans un projet est la clé.
* Niveau d'indentation: Combien d'espaces ou d'onglets constituent un niveau d'indentation? Les choix courants comprennent 2, 4 ou 8.
2. Conventions de dénomination:
* dénomination variable: Comment nommer des variables (par exemple, «camelcase», «Snake_case», `Pascalcase»).
* Noming de la fonction: Semblable à la dénomination variable, avec des conventions potentiellement différentes.
* Noming de classe: Conventions de capitalisation et de dénomination pour les classes (par exemple, `ClassName»).
* dénomination constante: Conventions pour déclarer et nommer les constantes (par exemple, `all_caps`).
3. Commentaires:
* Style de commentaire: Comment rédiger des commentaires (par exemple, en utilisant `//` ou `/ * * /` pour les commentaires en une seule ligne et multi-lignes).
* Contenu de commentaire: Quelles informations incluent dans les commentaires (par exemple, expliquer la logique du code, la documentation des fonctions, etc.).
4. Placement de l'accident:
* K&R Style: Ouverture de l'attelle sur la ligne suivante après l'instruction, fermant l'attelle alignée avec l'instruction d'ouverture.
* style Allman: Ouverture de l'attelle sur la ligne suivante, en retrait au même niveau que l'instruction, fermant l'attelle alignée sur le premier caractère de la déclaration d'ouverture.
* Style BSD: Ouverture de l'attelle sur la même ligne que l'instruction, fermant l'attelle sur une nouvelle ligne.
5. Longueur de ligne:
* Longueur de ligne maximale: Une recommandation commune consiste à limiter les lignes à 80 caractères. Cela améliore la lisibilité sur les écrans plus petits et dans les éditeurs de code.
6. Formatage du code:
* lignes vierges: Utilisation de lignes vierges pour séparer visuellement différents blocs de code.
* Espacement: Utilisation d'espaces autour des opérateurs, après des virgules, etc.
7. Conventions spécifiques à la langue:
* python: PEP 8 (Python Enhancement Proposal 8) fournit un ensemble complet de directives de style pour le code Python.
* java: Sun Microsystems a publié des conventions de codage Java qui couvrent de nombreux aspects du style.
* C #: Les conventions de codage C # de Microsoft fournissent des conseils pour la rédaction du code C #.
8. Ligneurs de style de code:
* Des outils comme Eslint (pour JavaScript), Pylint (pour Python) et Stylecop (pour C #) peuvent vérifier automatiquement le code pour l'adhésion aux directives de style spécifiques.
9. Styles spécifiques au projet:
* Différents projets peuvent adopter leur propre guide de style spécifique, adapté à leurs besoins et préférences.
Choisir un style de codage:
* La cohérence est la clé: Choisissez un style et respectez-le régulièrement dans un projet.
* Accord d'équipe: Assurez-vous que tout le monde dans l'équipe est d'accord et suit le guide de style choisi.
* lisibilité et maintenabilité: Choisissez un style qui favorise la lisibilité et la maintenabilité du code.
N'oubliez pas que le style de codage concerne la communication Au sein d'une équipe et rendre le code plus facile à lire et à comprendre. Choisissez un style qui fonctionne pour votre projet et maintenez la cohérence!
|
