BT

Diffuser les Connaissances et l'Innovation dans le Développement Logiciel d'Entreprise

Contribuez

Sujets

Sélectionner votre région

Accueil InfoQ Actualités Les standards de codage de Google

Les standards de codage de Google

Google a récemment publié leur définition complète des standards de codage pour le code source Java. Ce sont des règles strictes qui sont facilement applicables et suivies de manière universelle au sein de Google. Elles ne couvrent pas uniquement le formatage, mais aussi d'autres types de convention et de standard de codage.

Le document est structuré en 6 sections principales : Bases, Structuration du Fichier Source, Formatage, Nommage, Pratiques de Programmation et Javadoc. La section Bases concerne les noms de fichier, l'encodage, les caractères d'espacement, et les caractères spéciaux. La section Structuration du Fichier Source concerne l'information de licence, les déclarations de package et d'import, et l'ordre des membres dans la classe. La section Formatage décrit les accolades, les indentations, la gestion du line-wrapping, les blancs, les parenthèses, les énumérations, les tableaux, les déclarations switch, les annotations, les commentaires et les modificateurs. La section Nommage concerne les identifiants (package, classe, méthode, constante, champ, variable locale, variable de type) et définit le CamelCase. La section Pratiques de Programmation parle d'@Override, des exceptions, des membres statiques et des destructeurs. Finalement, la section Javadoc décrit comment formater la Javadoc et où elle est nécessaire.

Voici quelques éléments contenus dans le guide :

  • Pas d'imports Joker
  • Les surcharges apparaissent séquentiellement
  • Les accolades sont utilisées même si le corps est vide ou contient une unique déclaration
  • Indentation de 2 espaces
  • La limite de colonne peut être de 80 ou de 100 caractères
  • Pas de déclarations de tableau à la C
  • Les modificateurs sont déclarés dans l'ordre préconisé par la Spécification du Langage Java
  • Les constantes utilisent la CASSE_CONSTANTE. Notez que toute constante est un champ statique et final, mais que tous les champs statiques et finaux ne sont pas des constantes.

Pour aller plus loin, consultez le Style Java Google. Il existe également les Conventions de Code officielles pour le Langage de Programmation Java d'Oracle. Google fournit également des guides de style pour d'autres langages comme C++, Objective-C, Python, Shell, HTML/CSS, JavaScript et Lisp.

Evaluer cet article

Pertinence
Style

Contenu Éducatif

BT