Qu'est-ce qu'un code "propre" selon vous ?

**berceker united** · 14/05/2009, 10h10

C'est le genre de question ou il y a pas de réponse claire.
C'est comme dire si un livre est bien écrit.
De quoi parle t-on ?
Un livre peut être bien écrit mais l'histoire est mal monté et incompréhensible.

Pour le code c'est pareille. Vous pouvez faire du très beau code ou c'est bien aéré, indenté comme un dieux, etc. Mais au final vous vous prenez au charme du code mais vous comprenez pas ce que ça fait exactement parce que c'est complètement tordu.
Pour moi un code propre c'est un code assez claire pour comprendre au premier ou second coup d'œil ce qu'il fait.

**white_tentacle** · 14/05/2009, 10h17

Pour la définition de propre :
http://www.cnrtl.fr/definition/propre (pour mieux comprendre ma première réponse).

Et je crois vraiment que c'est la seule bonne réponse à cette question, qui est très mal formulée

.

Pour le reste, un code de qualité, c'est un code qui, pour chaque fonction, définit son contrat, pour chaque boucle, déclare son ou ses variants, pour chaque objet, ses invariants.

Une fois qu'on a ça le reste vient en général avec (allez garantir une postcondition sur une fonction de 300 lignes, allez définir des contrats sur une conception foireuse, etc...)

**chaplin** · 14/05/2009, 10h39

Qu'est ce que c'est que du code qui n'est pas propre

?

**FR119492** · 14/05/2009, 10h43

Salut!

pas d'instruction GOTO dans les programmes

la programmation objet va naturellement dans le sens d'un code plus "propre"

Pour moi, un programme est un moyen de dire à un processeur ce que je veux qu'il fasse. Même s'il écrit dans un langage plus évolué, le programmeur devra toujours avoir à l'esprit le code machine que son compilateur produira, afin d'utiliser de manière optimale les spécificités de son hardware. Or il y a dans le code machine de mon ordinateur une instruction qui est la traduction littérale du GOTO; celui-ci doit donc exister dans le langage de programmation que j'utilise. D'autre part, je n'ai jamais trouvé, dans la documentation des processeurs que j'ai utilisés, la moindre allusion à un code machine orienté objet.
Jean-Marc Blanc

**Hephaistos007** · 14/05/2009, 11h37

Envoyé par FR119492

Pour moi, un programme est un moyen de dire à un processeur ce que je veux qu'il fasse.

Oui, comme tout le monde ici j'espère.

Envoyé par FR119492

Même s'il écrit dans un langage plus évolué, le programmeur devra toujours avoir à l'esprit le code machine que son compilateur produira, afin d'utiliser de manière optimale les spécificités de son hardware.

D'une part, cette remarque relève de l'informatique industrielle, mais n'a pas lieu d'être dans l'informatique de gestion (qui flotte dans l'air ambiant de ce forum). En informatique de gestion, plus on se concentre sur le métier en masquant la technique, mieux c'est (alors un GOTO ou un décalage de bit ...). D'autre part, en 2009, les compilateurs font les optimisations à notre place, même en info industrielle je pense

Envoyé par FR119492

Or il y a dans le code machine de mon ordinateur une instruction qui est la traduction littérale du GOTO; celui-ci doit donc exister dans le langage de programmation que j'utilise.

C'est tout l'inverse des efforts entrepris ces 20 dernières années pour créer des langages plus structurés et à plus haut niveau d'abstraction.

Envoyé par FR119492

D'autre part, je n'ai jamais trouvé, dans la documentation des processeurs que j'ai utilisés, la moindre allusion à un code machine orienté objet.
Jean-Marc Blanc

Forcément, c'est le principe même de la remarque précédente.

**chaplin** · 14/05/2009, 12h13

Envoyé par Hephaistos007

Envoyé par FR119492

Même s'il écrit dans un langage plus évolué, le programmeur devra toujours avoir à l'esprit le code machine que son compilateur produira, afin d'utiliser de manière optimale les spécificités de son hardware.

D'une part, cette remarque relève de l'informatique industrielle, mais n'a pas lieu d'être dans l'informatique de gestion (qui flotte dans l'air ambiant de ce forum). En informatique de gestion, plus on se concentre sur le métier en masquant la technique, mieux c'est ...

Ce passage là devrait à mon avis relevé d'un topic à part entière, car il oppose la virtualisation au "hardware". D'ailleurs, .NET et JVM montrent l'exemple dans l'idée d'être indépendant de la machine, sauf certains SGBDR qui font exceptions à la règle (curieusement).

**benji_dv** · 14/05/2009, 13h04

oui, et j'ajouterais une notion à ce qui est dit,
a mes yeux un code propre contient des méthodes qui ont
un seul point d'entrée ... (par définition)
et un seul point de sortie... (pas de plusieurs "return" en plein milieu),

mais cela rejoint l'idée : "bonne lisibilité"

**Matthieu Brucher** · 14/05/2009, 13h28

Envoyé par benji_dv

oui, et j'ajouterais une notion à ce qui est dit,
a mes yeux un code propre contient des méthodes qui ont
un seul point d'entrée ... (par définition)
et un seul point de sortie... (pas de plusieurs "return" en plein milieu),

mais cela rejoint l'idée : "bonne lisibilité"

Dans un langage objet, la lisibilité fait qu'on ne va surtout pas se forcer à avoir un seul point de sortie.

**white_tentacle** · 14/05/2009, 13h31

un seul point de sortie... (pas de plusieurs "return" en plein milieu),

Au contraire, avoir plusieurs points de sortie améliore la lisibilité (sinon, on se paluche des blocs imbriqués dans tous les sens, et je ne compte pas le nombre de fois où j'ai vu la variable retour de la fonction changer 5 ou 6 fois de valeur avant le return final...). Ca a par contre d'autres problèmes, selon les langages (en fait, dans les langages sans destructeur et sans garbage collector, c'est rapidement catastrophique en terme de gestion de mémoire).

**Franck SORIANO** · 14/05/2009, 13h38

Envoyé par Matthieu Brucher

Dans un langage objet, la lisibilité fait qu'on ne va surtout pas se forcer à avoir un seul point de sortie.

Je ne vois pas pourquoi !
Lorsque tu te trouves dans le corps d'une méthode, il n'y a plus beaucoup de différences avec une procédure classique, non objet.

Objet ou pas objet, les problèmes sont les mêmes :
- Tu as une méthode qui fait un traitement.
- Tu as besoin de la modifier pour ajouter un truc en plus, tu vas à la fin et tu ajoutes ton code.
- Sauf qu'il y avait un return plus haut et ton code n'est pas exécuté...

**pseudocode** · 14/05/2009, 13h53

Pour moi, un code propre a une définition "objective" et une définition "subjective".

- Pour la partie "objective", je dirais qu'un code est propre s'il se conforme toujours aux mêmes règles de structuration et d'écriture. C'est à dire qu'il y a une "logique" de découpage et de codage tout au long du code. Bref, qu'il y a une certaine constance ou uniformité dans le programme.

Par exemple des conventions de nommage, de présentation, des design patterns, des templates de code, ...

- Pour la partie "subjective", dans mon cas cela signifie que je suis d'accord (ou au moins habitué) aux règles qui sont utilisées.

**FR119492** · 14/05/2009, 14h06

Salut!

en 2009, les compilateurs font les optimisations à notre place

Ah! si seulement ...

des efforts entrepris ces 20 dernières années pour créer des langages plus structurés et à plus haut niveau d'abstraction.

Malheureusement! Dans mon métier, on travaille dans le concret.

Pour moi, on doit considérer deux critères:

Critère absolu: Le programme doit être lisible et bien documenté, afin qu'une personne autre que l'auteur puisse le comprendre et, cas échéant le modifier sans difficultés majeures.
Critère relatif: Un programme est plus propre qu'un autre si, sur le même matériel, il accomplit les mêmes tâches en moins de temps (test du chronomètre).

Jean-Marc Blanc

**el_slapper** · 14/05/2009, 14h25

Envoyé par FR119492

(.../...)
Pour moi, on doit considérer deux critères:

Critère absolu: Le programme doit être lisible et bien documenté, afin qu'une personne autre que l'auteur puisse le comprendre et, cas échéant le modifier sans difficultés majeures.
Critère relatif: Un programme est plus propre qu'un autre si, sur le même matériel, il accomplit les mêmes tâches en moins de temps (test du chronomètre).

Comme disait Einstein, tout est relatif. En informatique de gestion, j'ai à refondre des boucles gérées avec des GO TO. Je les remplace par des boucles PERFORM VARYING(boucles for pour les non cobolistes). J'ignore si c'est plus performant ou moins performant. Ce que je sais, c'est que les programmeurs d'aujourd'hui ne savent pas lire un code plein de GO TO, alors que les "anciens" (on en a pas mal), eux, trouvent ça plus facile. Comme ils sont amenés à partir en retraite, on éradique leurs gotos, parait-il très lisibles, mais auxquels nous jeunots ne comprenons goutte.

**pseudocode** · 14/05/2009, 14h31

Envoyé par FR119492

Critère relatif: Un programme est plus propre qu'un autre si, sur le même matériel, il accomplit les mêmes tâches en moins de temps (test du chronomètre).

??

Code java :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
double invSqrt(double x) {
	double xhalf = 0.5 * x; 
	long i = Double.doubleToRawLongBits(x);
	i = 0x5FE6EB50C7B537AAL - (i>>1); 
	x = Double.longBitsToDouble(i);
	x = x * (1.5 - xhalf*x*x); 
	return x; 
}

Code java :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
 
double invSqrt(double x) { return 1 / Math.sqrt(x); }

**Matthieu Brucher** · 14/05/2009, 17h09

Envoyé par Franck SORIANO

- Sauf qu'il y avait un return plus haut et ton code n'est pas exécuté...

Justement, avec des objets, ce genre de choses est effectué automatiquement (cf le principe RAII).

**clavier12AZQSWX** · 14/05/2009, 17h49

Un code propre est un code où lorsqu'on enlève le code, il ne reste que des lignes de commentaires parlant et explicites retraçant les SF et/ou le CDC !

si il ne reste rien, c'est un code sale !

**Matthieu Brucher** · 14/05/2009, 18h06

Envoyé par Michael REMY

Un code propre est un code où lorsqu'on enlève le code, il ne reste que des lignes de commentaires parlant et explicites retraçant les SF et/ou le CDC !

si il ne reste rien, c'est un code sale !

Pas tout à fait d'accord non plus. Le code doit être une documentation à lui tout seul. De nombreux développeurs reconnus pour leur demande de code propre écrivent le moins de commentaires possible. A partir du moment où une fonction a un nom explicite quant à ce qu'elle fait, qu'elle est courte et que le code fait ce que le nom indique, pourquoi ajouter des commentaires ?

**Franck SORIANO** · 14/05/2009, 19h39

Envoyé par Matthieu Brucher

Justement, avec des objets, ce genre de choses est effectué automatiquement (cf le principe RAII).

Je ne vois pas le rapport. Je ne parlais pas de nettoyage...

**Matthieu Brucher** · 14/05/2009, 19h43

Dans ce cas, on va reprendre ton message original :

Objet ou pas objet, les problèmes sont les mêmes :
- Tu as une méthode qui fait un traitement.
- Tu as besoin de la modifier pour ajouter un truc en plus, tu vas à la fin et tu ajoutes ton code.
- Sauf qu'il y avait un return plus haut et ton code n'est pas exécuté...

Tu dois ajouter un truc en plus ? Tu refactores, pour que ton code reste propre.
Cela doit être appelé quoiqu'il arrive à la fin de la fonction ? OK, RAII. Et je ne parle pas de nettoyage.

**Lorantus** · 14/05/2009, 20h56

Je ne peux pas tenir plus longtemps... je le crierai le je pouvais !

Une bible est sortie... J'éspére que ce sera pas le seul livre... J'éspére qu'il sera le père de milliers de livres...

A lire impérativement Coder Proprement de de Robert C.Martin.

Et pourquoi pas un blog/site Web ?

Qu'est-ce qu'un code "propre" selon vous ?

Débats sur le développement - Le Best Of

Discussions similaires

Partager

Partager