1. Guides de style¶
L’un des objectifs de l’enseignement d’informatique en CPGE est de vous apprendre à programmer avec élégance. Un code bien écrit est facile à comprendre, à répliquer et à déboguer.
Tout comme il existe une variété de langages parlés et écrits, chaque langage de programmation a une syntaxe unique avec des règles grammaticales et un style souhaité. Certains éléments de style - comme donner des noms descriptifs aux variables - sont les mêmes pour chaque langue.
Vous trouverez ci-dessous les directives de style pour les différents langages enseignés en CPGE. Certains d’entre eux sont des directives générales de style de programmation et d’autres sont spécifiques à des langages. Vos devoirs contiennent souvent des points de style autogradés et notés manuellement et l’écriture d’un code bien écrit demande de la pratique, alors prenez le temps de réfléchir à l’amélioration de votre code avant de soumettre chaque devoir.
1.1. Liste¶
styleguide/Guide de style OCaml
styleguide/Guide de style C
styleguide/Guide de style Python
styleguide/Guide de style Makefile
styleguide/Guide de style Bash
TODO: more ?
1.2. Références¶
OCaml : CIS 120 OCaml Style Guide à l”Université de Pennsylvanie ;
C : ma référence en français est le WikiBooks:Conseils de codage en C
Python : en français « Le guide de l’auto-stoppeur pour Python ! » est MA référence, et en anglais je recommande PEP8 ou celui de Google, un peu long mais exhaustif ;
Makefile : ce tutoriel en français donne des bonnes pratiques, et celui-ci en anglais ;
Pour d’autres langages, si besoin, cette liste de « style guides » maintenu par Google est utile ;
TODO: Aussi parler de linter/formateur automatiques ?