Zoom sur les « Source code beautifier »

….BEAUTIFIER – Un formateur de code source ?

Un formateur de code source (source code beautifier) est un logiciel qui prend en entrée un fichier contenant du code source et le transforme en un fichier équivalent formaté selon des règles définies par l’utilisateur. Ces règles peuvent couvrir beaucoup d’aspects allant de l’indentation, les emplacements réservés aux espaces, la syntaxe utilisée pour les commentaires ou la longueur des lignes de code.

L’idée est ici d’unifier le format du code source à l’échelle d’un développeur, d’un projet voir d’une entreprise afin de faciliter la réutilisation et la lisibilité de celui-ci. On peut opposer cette idée à l’obfuscation de code source qui à l’inverse vise à protéger le code en le rendant inintelligible.

Pourquoi?

Les développeurs passent un temps considérable à lire du code. Standardiser le format de celui-ci permet une économie de temps et de budget pour diverses raisons:

  • Le format utilisé fait partie de l’identité de l’équipe de développement (voir de l’entreprise) de plus même du code externe peut être intégré en adoptant ce format.
  • Une indentation régulière et rigoureuse facilite l’identification des blocs dans le code.
  • Le temps perdu à reformater le code pour le rendre plus lisible disparaît.
  • Moins de différences apparaissent lors de comparaisons de fichiers ou de versions différentes d’un même fichier (très utilisé pour la gestion de versions).

Comment?

Plusieurs logiciels existent pour formater le code source. On peut citer pêle-mêle Artistic Style, Indent (membre du projet GNU) ou Uncrustify. La plupart des IDE intègrent par ailleurs certaines des fonctionnalités de ces logiciels comme l’auto-indentation.

On peut dégager 3 modes d’utilisation:

➡ L’utilisation locale : l’utilisateur installe sur son poste le logiciel et l’utilise sur son code “en local”. Les règles de formatage pouvant souvent être partagées au moyen d’un fichier de configuration commun

➡ L’intégration dans un IDE :comme dit précédemment certaines fonctionnalités sont souvent déjà présentes dans les environnements de développement. Cependant pour tirer pleinement parti des “code beautifier” il est parfois possible de les intégrer sous forme de plug-in ou de greffons à certains IDE

➡ L’utilisation dans l’intégration continue :couplé avec l’outil de gestion de version tout le code source entrant dans la base d’une équipe de développement est ainsi garanti de respecter le format défini en amont.

Avantages et inconvénients des “source code beautifier”

Conclusion

L’utilisation de formateur de code source devient une pratique courante à l’heure ou l’intégration continue devient la norme dans les processus de développement. Les multiples avantages que ceux-ci présentent comblent largement les quelques inconvénients relatifs à leur mise en place. C’est finalement un formidable outil pour travailler ensemble.

Nous développons au sein de l’équipe de SII à Grenoble une expertise forte autour de ces sujets, notamment dans des environnements industriels critiques. N’hésitez pas à nous solliciter sur ces points.

 

Marvin TRIJASSE – mtrijasse@sii.fr – 04 38 12 39 14

Laisser un commentaire

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

12 + 15 =