Règles du bon pseudocode

Quelques raccourcis :

Identification
Nomenclature
Règles générales
Opérations primitives
Autres opérations
Tests

Le pseudocode est un langage pour exprimer clairement et formellement un algorithme. Ce langage est près d'un langage de programmation comme Pascal, C# ou C++, sans être identique à l'un ou à l'autre. Il exprime des idées formelles dans une langue près du langage naturel de ses usagers (pour nous, le français) en lui imposant une forme rigoureuse.

Quelques trucs suivent pour vous aider à rédiger du « bon » pseudocode.

Identification

Il est essentiel d'identifier l'auteur de tout document remis au professeur, même s'il ne s'agit « que » de pseudocode. Assurez-vous de respecter les règles d'identification en vigueur dans votre cours.

Nomenclature

Pour une réflexion plus poussée sur la nomenclature, voir ../../Sujets/Developpement/Pratique-programmation.html#nomenclature

Quelques règles de nommage simples suivent :

Le nom d'une variable ou d'une constante doit être significatif. On devrait savoir immédiatement, à partir de son nom, à quoi sert la variable ou la constante, et quel sens donner à sa valeur
Les majuscules et les minuscules sont des symboles distincts dans la plupart des langages de programmation, mais pas tous. Ainsi, pour éviter les ennuis, ne donnez pas à deux entiés (une variable et une constante, par exemple) des noms qui ne différeraient que sur cet aspect
Les règles de programmatique imposées doivent être respecées (ces règles varient selon les entreprises ou les cours, alors renseignez-vous!)

Règles générales

En pseudocode :

Les instructions se font une ligne à la fois (pas de ';' en pseudocode)

Correct	Incorrect
`PI ← 3,14159 Lire rayon volume ← 4 / 3 * PI * rayon ^ 3 Écrire volume`	`PI ← 3,14159; Lire rayon; volume ← 4 / 3 * PI * rayon ^ 3; Écrire volume;`

Si une ligne est trop longue, on vise une indentation permettant de comprendre où l'expression se termine

Correct Incorrect

Correct	Incorrect
`TAUX_CHANGE_CANADIEN ← 0,79 lire montantCanadien montantAmérican ← montantCanadien * TAUX_CHANGE_CANADIEN // ou encore montantAmérican ← montantCanadien * TAUX_CHANGE_CANADIEN Écrire montantAméricain`	`TAUX_CHANGE_CANADIEN ← 0,79 lire montantCanadien // présentation confuse montantAmérican ← montantCanadien * TAUX_CHANGE_CANADIEN Écrire montantAméricain`

TAUX_CHANGE_CANADIEN ← 0,79
lire montantCanadien
montantAmérican ← montantCanadien * TAUX_CHANGE_CANADIEN
// ou encore
montantAmérican ← montantCanadien *
                  TAUX_CHANGE_CANADIEN
Écrire montantAméricain

TAUX_CHANGE_CANADIEN ← 0,79
lire montantCanadien
// présentation confuse
montantAmérican ← montantCanadien *
TAUX_CHANGE_CANADIEN
Écrire montantAméricain

On ne se préoccupe pas des types des variables et des constantes

Correct	Incorrect
`PI ← 3,14159 Lire rayon volume ← 4 / 3 * PI * rayon ^ 3 Écrire volume`	`const float PI ← 3,14159 float rayon, volume Lire rayon volume ← 4 / 3 * PI * rayon ^ 3 Écrire volume`

Certains profs accepteront des commentaires à même le pseudocode (typiquement préfixés de // comme c'est le cas dans plusieurs langages). Dans le doute, consultez votre professeur pour connaître sa position sur le sujet

Opérations primitives

Le symbole ← utilisé pour l'affectation en pseudocode est un emprunt direct au langage APL, qui a inspiré plusieurs autres langages

À propos des opérations primitives exprimées en pseudocode :

Les opérations primitives sont Lire, Écrire et ←
Les constantes littérales peuvent être des nombres comme 3, des expressions reposant sur des constantes comme 4/3, ou du texte comme "J'aime mon prof" ou "123"
Les entrées se font avec Lire. Cette primitive modélise une lecture (par exemple au clavier) et le dépôt de la valeur lue dans une variable

Correct Incorrect

Correct	Incorrect
`Lire hauteur Lire largeur Lire nom`	`// une constante ne peut être lue au clavier, par définition Lire HAUTEUR // le littéral "largeur" est du texte; ce n'est pas une variable Lire "largeur" // la primitive Lire ne lit qu'une variable à la fois Lire hauteur, largeur ,nom`

Lire hauteur
Lire largeur
Lire nom

// une constante ne peut être lue au clavier, par définition
Lire HAUTEUR
// le littéral "largeur" est du texte; ce n'est pas une variable
Lire "largeur"
// la primitive Lire ne lit qu'une variable à la fois
Lire hauteur, largeur ,nom

Les sorties se font avec Écrire. Cette primitive modélise la projection d'une valeur (littéral, variable, constante) à l'écran

Correct

Correct
`Écrire surface Écrire TAILLE Écrire 3 Écrire "J'aime mon prof" // affichera 5 Écrire 2 + 3 // affichera le texte 2 + 3 Écrire "2 + 3" // Présumant une fonction Sqrt qui calcule et retourne la racine carrée // de son paramètre, ce qui suit affichera 4 Écrire Sqrt(16)`

Écrire surface
Écrire TAILLE
Écrire 3
Écrire "J'aime mon prof"
// affichera 5
Écrire 2 + 3
// affichera le texte 2 + 3
Écrire "2 + 3"
// Présumant une fonction Sqrt qui calcule et retourne la racine carrée
// de son paramètre, ce qui suit affichera 4
Écrire Sqrt(16)

L'affectation se fait avec ←

Correct Incorrect

Correct	Incorrect
`PI ← 3,14159 Lire hauteur surface ← hauteur ^ 2 résultat ← Sqrt(4) message ← "J'aime mon prof"`	// on ne peut modifier un littéral 3 ← hauteur "J'aime mon prof" ← message // on ne peut modifier un appel de fonction Sqrt(4) ← résultat // on ne peut modifier une expression 2 + 3 ← 5

PI ← 3,14159
Lire hauteur
surface ← hauteur ^ 2
résultat ← Sqrt(4)
message ← "J'aime mon prof"

// on ne peut modifier un littéral
3 ← hauteur
"J'aime mon prof" ← message
// on ne peut modifier un appel de fonction
Sqrt(4) ← résultat
// on ne peut modifier une expression
2 + 3 ← 5

On ne permet qu'une seule opération primitive par ligne

Correct Incorrect

Correct	Incorrect
`PI ← 3,14159 E ← 2,71828 Lire hauteur surface ← hauteur ^ 2 résultat ← Sqrt(4) message ← "J'aime mon prof"`	PI ← 3,14159, E ← 2,71828 Lire hauteur, largeur Écrire "J'aime mon prof" nomDuProf "!"

PI ← 3,14159
E ← 2,71828
Lire hauteur
surface ← hauteur ^ 2
résultat ← Sqrt(4)
message ← "J'aime mon prof"

PI ← 3,14159, E ← 2,71828
Lire hauteur, largeur
Écrire "J'aime mon prof" nomDuProf "!"

Une constante ne peut être initialisée qu'une seule fois, et ce doit être à l'aide du symbole d'affectation lors de sa déclaration. Après tout, par définition, une fois déclarée, une constante ne peut plus changer de valeur

Correct Incorrect

Correct	Incorrect
`PI ← 3,14159 E ← 2,71828 MESSAGE ← "J'aime mon prof"`	`PI ← 3,14159 // on ne peut lire la valeur d'une constante : cette valeur est fixée a priori Lire PI MESSAGE ← "J'aime mon prof" // on ne peut plus modifier une constante une fois celle-ci initialisée MESSAGE ← "Moi aussi!"`

PI ← 3,14159
E ← 2,71828
MESSAGE ← "J'aime mon prof"

PI ← 3,14159
// on ne peut lire la valeur d'une constante : cette valeur est fixée a priori
Lire PI
MESSAGE ← "J'aime mon prof"
// on ne peut plus modifier une constante une fois celle-ci initialisée
MESSAGE ← "Moi aussi!"

Exemple simple d'un programme calculant et affichant le volume d'une sphère, étant donné son rayon, le tout exprimé en pseudocode. Notez la constante en majuscules, les noms de variables, la notation pour l'affectation, etc.

PI ← 3,14159
Lire rayon
volume ← 4 / 3 * PI * rayon^3
Écrire volume

Autres opérations

Le pseudocode ne se limite pas aux opérations primitives.

Opérations arithmétiques

Les opérateurs arithmétiques admis sont les suivants :

Notation en pseudocode	Équivalent en notation mathématique	Sens
`a + b`	$a+b$	Addition de a et de b
`a - b`	$a-b$	Valeur de a à laquelle on aurait soustrait b
`a * b`	$a \times b$	Produit de a et de b
`a / b`	$\frac{a}{b}$	Quotient de la division depar(indéfini si $b=0$ )
`a % b`	$a \bmod b$	Reste de la division depar(indéfini si $b=0$ )
`a ^ b`	$a^b$	Résultat de l'élévation de a à la puissance b

Sur le plan de la notation, le pseudocode se limite à du texte susceptible d'être écrit au clavier. De même, la multiplication doit être exprimée explicitement

Correct	Incorrect
`PI ← 3,14159 Lire x y ← 2 * x volume ← 4 / 3 * PI * rayon ^ 3 Écrire Sqrt(x+y)`	`$\pi$ ← 3,14159 Lire x y ← $2x$ volume ← $\frac{4}{3}\pi \times rayon^3$ Écrire $\sqrt{x+y}$`

Opérations relationnelles

Les opérateurs relationnels admis sont les suivants :

Notation en pseudocode	Équivalent en notation mathématique	Sens
`a < b`	$a \lt b$	a est plus petit que b (a précède b)
`a <= b`	$a \le b$	a est plus petit ou égal à b
`a > b`	$a \gt b$	a est plus grand que b (a suit b)
`a >= b`	$a \ge b$	a est plus grand ou égal à b
`a = b`	$a = b$	a est égal à b
`a != b`	$a \ne b$	a est différent de b

Opérations logiques

Les opérateurs logiques admis sont les suivants :

Notation en pseudocode	Équivalent en notation mathématique	Sens
`a ET b`	$a \land b$	Vrai seulement si a et b sont tous deux vrais
`a OU b`	$a \lor b$	Faux seulement si a et b sont tous deux faux
`NON a`	$\lnot a$	Vrai seulement si a est faux

Tests

Un programme peut être testé même lorsqu'il n'existe que sous forme de pseudocode :

Tester un algorithme, écrit en pseudocode ou dans un autre langage, demande d'utiliser comme jeu d'essai à la fois des valeurs typiques et des cas limites.