styleguide

Chaque grand projet open-source a son propre guide de style: un ensemble de conventions (parfois arbitraires) sur la façon d’écrire du code pour ce projet. Il est beaucoup plus facile de comprendre une grande base de code lorsque tout le code qu’elle contient est de style cohérent.

« Style » couvre beaucoup de terrain, de ”utiliser CamelCase pour les noms de variables » à ”ne jamais utiliser de variables globales » en passant par « ne jamais utiliser d’exceptions.”Ce projet (google / styleguide) renvoie aux directives de style que nous utilisons pour le code Google. Si vous modifiez un projet qui a été créé chez Google, vous pouvez être dirigé vers cette page pour voir les guides de style qui s’appliquent à ce projet.

Ce projet contient le Guide de Style C++, le Guide de Style C #, le Guide de Style Swift, le Guide de Style Objective-C, le Guide de Style Java, le Guide de Style Python, le Guide de Style R, le Guide de Style Shell, le Guide de Style HTML / CSS, le Guide de Style JavaScript, le Guide de Style TypeScript, le Guide de Style AngularJS, le Guide de Style Common Lisp et le Guide de Style Vimscript. Ce projet contient également cpplint, un outil d’aide à la conformité au guide de style, et google-c-style.el, un fichier de paramètres Emacs pour le style Google.

Si votre projet nécessite de créer un nouveau format de document XML, le Guide de style de format XMLDocument peut être utile. En plus des règles de style réelles, il contient également des conseils sur la conception des vôtres par rapport à l’adaptation d’un format existant, sur le formatage du document d’instance XML et sur les éléments par rapport aux attributs.

Les guides de style de ce projet sont sous licence CC-By 3.0, ce qui vous encourage à partager ces documents.Voir https://creativecommons.org/licenses/by/3.0/ pour plus de détails.

Laisser un commentaire

Votre adresse e-mail ne sera pas publiée. Les champs obligatoires sont indiqués avec *