UKOnline

Allure d'un programme

Cette dernière section va s'intéresser à quelques conventions sur la manière d'écrire le code source d'un programme de manière « propre ». Il s'agit évidemment de lignes de conduite que l'on peut suivre ou non.

La première chose à ne pas oublier est qu'on va écrire une classe dans un fichier texte et que le nom du fichier doit absolument être le même que le nom de la classe. Par exemple, le programme de la figure 16 doit absolument être enregistré dans un fichier dont le nom est Allure.java.

Le fichier Allure.java.

Blanc

Le texte d'un programme est composé de mots, composants élémentaires. Ce sont les noms, les mots réservés, les littéraux, les opérateurs et les signes de ponctuation. La contrainte d'indivisibilité entraine que les mots d'un programme ne peuvent en aucun cas contenir des blancs (espace, tabulation, saut de ligne, etc.).

Il serait incorrect d'écrire le code suivant car les noms System, out et print, ainsi que le littéral 123456 ont été coupés par des blancs.

Comme on l'a vu, pour le littéral 123456, on aurait pu l'écrire comme 123_456 en Java. Par contre, on peut mettre autant de blancs qu'on le souhaite entre les mots. On peut également ne mettre aucun blanc du tout. On pourrait donc réécrire les deux instructions sur une seule ligne et donc écrire :

Se passer complètement de blancs rend le code source beaucoup moins lisible, surtout dans des programmes de plus grande ampleur. Voyez à quoi ressemble le programme Allure sans les blancs non-nécessaires :

Il est donc préférable d'utiliser les blancs à bon escient pour assurer une meilleure lisibilité et donc faciliter la compréhension par d'autres programmeurs, ou encore la correction lors d'erreur, par exemple.

Si vous mettez votre programme sur une seule ligne et que celui-ci contient une erreur, la ligne indiquée par le compilateur ou par la machine virtuelle sera la ligne 1 ! Ceci ne vous aidera pas forcément à trouver l'erreur, surtout si le message d'erreur est trop imprécis.

Mais vous l'aurez compris, il ne faut pas exagérer :

Ce que nous vous présenterons dans les chapitres suivants suit une convention très utilisée par beaucoup de programmeurs. Bien entendu, vous faites comme vous le sentez, à vous de choisir votre propre style.

En ce qui concerne les accolades, il y a essentiellement deux écoles : le style Allmann consiste à toujours mettre les accolades toutes seules sur une seule ligne, et l'accolade fermante est toujours en face, verticalement, à l'accolade ouvrante correspondante.

L'autre façon de faire est le style Kernighan et Ritchie qui consiste à mettre l'accolade ouvrante au bout de la ligne :

Le code source parait bien plus étouffé et les blocs de code sont plus difficilement identifiables. Pour cette raison principalement, nous utiliserons le style Allmann dans ce livre.

Convention

On a déjà parlé de quelques conventions dans ce chapitre; on va maintenant les reprendre. Il ne s'agit que de conventions, vous n'êtes de nouveau pas du tout obligés de les suivre. Sachez néanmoins que la plupart des gens les suivent, ce qui permet d'échanger des programmes qui seront plus facilement lisibles par tout le monde.

Par convention, lorsqu'il faut choisir un nom pour une classe, on va commencer par une majuscule, tandis que pour une variable, on va commencer par une minuscule. Pour les constantes, on choisit un nom complètement en majuscule.

Rappelez-vous également que Java est sensible à la casse ; donc, si on a besoin de trois variables, on peut les appeler var, vAR, vAr... Cette pratique est néanmoins tout à fait déconseillée puisqu'elle conduit à des distractions et rend le code illisible et incompréhensible.

Enfin, lorsque vous souhaitez introduire un littéral de type long, utilisez L plutôt que l, car ce dernier peut être facilement confondu avec un 1.

La seule différence entre 1 et l est le premier trait qui est incliné dans le chiffre 1, mais horizontal pour la lettre l, ceci dépendant bien entendu de la police utilisée.