Comment connaître les styles de codage acceptés

StackOverflow https://stackoverflow.com/questions/232975

  •  04-07-2019
  •  | 
  •  

Question

Où trouver des informations sur la mise en forme du code source (la meilleure pratique en la matière), pour différentes langues, quelles sont les conventions pour nommer les variables, etc., pour l'indentation et l'emplacement des accolades, comment et où inclure des commentaires, etc.

Par exemple, pour le livre de C Kernighan et Ritchie, le langage de programmation C et Le guide de codage du noyau Linux de Linus ou Le Guide de style C ++ de Google et au moins pour Perl perlstyle - Guide de style Perl .

Éditer: J'aurais peut-être dû demander "Comment bien démarrer avec les styles de codage".

Était-ce utile?

La solution

Je ne donnerais pas trop sur de tels guides de style. C'est un bon début, mais à la fin, vous ou votre équipe allez développer vos propres styles de codage.

EDIT: Rob Kam a fait un commentaire dans lequel il souhaitait en savoir plus sur ces «conventions de départ».

C'est un bon point. Mais la plupart du temps, vous rejoindrez des projets existants, des projets open-source ou commerciaux, et les personnes qui y travaillent possèdent déjà une convention de code. Dans une entreprise, il existe probablement déjà une convention de code. Si vous démarrez un nouveau projet, commencez avec les conventions d'un autre projet que vous aviez auparavant.

Si vous démarrez réellement un nouveau projet avec un nouveau langage que vous n'aviez pas utilisé auparavant ... vous pouvez alors commencer avec les conventions d'un autre langage qui est en quelque sorte similaire (c'est-à-dire que pour un nouveau langage oo, vous pouvez utiliser les conventions de Java ou Smalltalk) et ajustez vos conventions à mesure que vous acquérez de l’expérience pour la nouvelle langue. Lorsque j'ai commencé à programmer en Java, j'ai utilisé mes conventions de codage Pascal. Certaines conventions pascal ne fonctionnaient pas très bien pour Java, mais avec le temps, j'ai abandonné certaines anciennes conventions et en ai développé de nouvelles.

S.Lott a eu l’idée de se pencher sur un projet open-source écrit dans la langue de votre choix. C'est une bonne idée de faire des suggestions sur les bonnes conventions. Srikanth a eu la bonne idée de demander de bonnes conventions ici à Stackoverflow. Une très bonne idée, car avec le temps, Stackoverflow deviendra une bonne référence pour les conventions de codage de cette façon.

Autres conseils

Ce qu’il ya de mieux qu’un livre, c’est de localiser le code source libre dans la langue de votre choix.

Plutôt qu'un livre - le travail de quelques auteurs et rédacteurs en chef - le code source de travail est un projet communautaire qui répond à des normes de communauté très évoluées.

Lorsque le client m'a demandé de l'aider avec les normes de codage, je préfère trouver un bon projet Open Source et fournir un court document de normes indiquant "Faites en sorte que cela ressemble à xxx". Le projet Apache Ant est un bon exemple pour le style Java.

Tout le monde a son exemple de projet open source préféré. Lisez du code qui fonctionne dans le monde réel et choisissez un favori. Émulez ce projet.

Je voudrais utiliser Google pour cela. Par exemple, pour rechercher les instructions de codage Java, je vais utiliser cette requête ou publiez-le dans Stack Overflow et demandez quelles sont les recommandations standard en matière de codage recommandées pour Java. Il est difficile de désigner une source unique pour toutes les langues.

Je vous suggérerais d'en choisir un pour votre entreprise / projet et de vous y tenir et de vous assurer qu'il s'agit d'un bon standard.

Microsoft possède une document de référence avec leurs conventions de codage qu'il peut être utile de consulter, même si vous n'utilisez pas C #. Au-delà des conventions de style et de base, les meilleures pratiques recommandées par d'autres ici, telles que Clean Code , sont des lectures essentielles pour la création de code maintenable et lisible qui auront du sens pour les futurs responsables de la maintenance de votre base de code.

Si vous utilisez Visual Studio (et quelques autres IDE modernes), les incohérences de base avec les conventions recommandées sont automatiquement soulignées (avec des suggestions de survol dans les versions récentes de VS). Dans VS, si votre équipe souhaite utiliser des normes différentes, il suffit d’ouvrir les propriétés du projet et de modifier les paramètres pour " Analyse de code " (dernier élément de menu de gauche). Plus ici: Utilisation de jeux de règles pour regrouper les règles d'analyse de code

Bonjour et bonne journée à tous

Eh bien, je dois dire que cela dépend Cela dépend si vous travaillez pour une entreprise ou si vous travaillez pour vous;)

Si vous travaillez pour une entreprise, vous devez accepter le style de nommage et les autres règles

.

et pour vous, il vous suffit de définir un style que tout le monde, y compris vous-même, peut comprendre instantanément quoi et comment

les crochets et autres est votre chemin

mais comme vous l'avez dit, il existe des langues individuelles qui ont donc leurs propres règles

et comme Mnementh a déclaré que chaque équipe avait un moyen de coder de manière peut-être stricte ou libre

C'est tout sans plus .... au revoir

Il existe les guides de style C et C ++ , une courte page de liens. aux guides de style, aux règles de codage et aux discussions de USENET, gérés par Christopher Lott.

Si vous êtes un développeur PHP , il ne faut pas manquer ces deux guides:

Licencié sous: CC-BY-SA avec attribution
Non affilié à StackOverflow
scroll top