Je suis un extrémiste du formatage

Je ne sais pas s'il s'agit d'un défaut ou d'une qualité. Je sais par contre que cela agace beaucoup de gens lorsqu'ils travaillent avec moi. Je le comprends : il ne doit pas être facile de supporter un mec qui te reprends constamment sur ton indentation.

En même temps, je trouve cela important. Nous sommes des écrivains. Nous écrivons du code. L'écriture passe par le formatage du texte. La compréhension d'un texte passe par le formatage de celui-ci.

J'adhère totalement aux propos d'un livre que j'ai lu dernièrement. Je vais reprendre ici une partie de son raisonnement car il me permet d'expliquer "clairement" ce que je pense.

L'idée est simple : le code change, le formatage reste.

Grotesque !! Et pourtant si. Un projet, un logiciel vit. Il est amené à évoluer et donc le code est amené à changer,  voire à être complètement réécrit. Le code que nous écrivons aujourd'hui n'existera peut-être sûrement plus demain.

Par contre la forme de notre code, la façon dont nous l'écrivons aujourd'hui va fortement impacter les modifications que nous allons faire dans le futur. D'elle va dépendre la maintenabilité, l'agilité de mon application.

Nous sommes bien d'accord que nous ne parlons pas uniquement d'indentation mais de formatage dans son sens large : comment est-ce que nous organisons notre fichier, notre classe, notre fonction ? Où est-ce que nous déclarons nos variables ? Quand est-ce que nous décidons de séparer du code en plusieurs fichiers ? Comment est-ce que nous nommons nos fonctions ou nos variables. Nos fichiers sont-ils trop longs ? Dans quel ordre allons-nous ranger nos méthodes ? Et bien sûr, comment allons-nous indenter notre code ? Est-il judicieux d'utiliser plus d'une ligne vide à la suite ? Les espaces seront-ils mis avant ou après les parenthèses ? Dans quels cas ?

Ce sont toutes des questions dont les réponses une fois apportées et appliquées vont impacter directement le code écrit dans le futur. Elles vont donc impacter tout le projet, du chiffrage des nouvelles fonctionnalités à la réalisation de celles-ci.

Ce sont toutes des questions de mise en forme que se pose à raison un écrivain qui veut être compris de ses lecteurs. Soyez de bons écrivains.