Guide des bonnes pratiques de codage Matlab - Historique des versions

Caveenj : /* Documents pertinents */

2017-07-20T17:46:55Z

Documents pertinents

Caveenj : 14 révisions importées

2017-06-01T18:49:28Z

14 révisions importées

Bourda02 : /* Quand doit-on mettre des espaces? */

2013-02-06T19:28:14Z

Quand doit-on mettre des espaces?

Dumoda01 le 25 janvier 2013 à 20:36

2013-01-25T20:36:37Z

Dumoda01 le 25 janvier 2013 à 20:34

2013-01-25T20:34:52Z

Dumoda01 le 25 janvier 2013 à 20:31

2013-01-25T20:31:01Z

Dumoda01 le 25 janvier 2013 à 20:23

2013-01-25T20:23:59Z

Dumoda01 le 25 janvier 2013 à 19:51

2013-01-25T19:51:54Z

Bourda02 : /* Dois-je documenter en anglais ou en français? */

2013-01-25T15:57:37Z

Dois-je documenter en anglais ou en français?

Bourda02 : /* Équations */

2013-01-25T15:55:04Z

Équations

← Version précédente		Version du 20 juillet 2017 à 17:46
Ligne 119 :		Ligne 119 :

	Le document [[Media:MatlabStyle1p5.pdf\|MatlabStyle5p1]] en est un duquel on pourrait s'inspirer en l'adaptant à l'océanographie.		Le document [[Media:MatlabStyle1p5.pdf\|MatlabStyle5p1]] en est un duquel on pourrait s'inspirer en l'adaptant à l'océanographie.
		+
		+	[[Category:Matlab]]

← Version précédente		Version du 6 février 2013 à 19:28
Ligne 91 :		Ligne 91 :

	== Quand doit-on mettre des espaces? ==		== Quand doit-on mettre des espaces? ==
		+
		+	On indente toujours les boucles de quelques espaces, généralement deux ou plus.
		+	Aussi on met un espace avant et après les signes d'égalité et d'inégalité ainsi que les opérations d'addition et de de soustractions.
		+	Par exemple:
		+	for i = 1:iMax
		+	for j = 1:jMax
		+	a = a + b;
		+	end
		+	end
		+
		+	Pour les multiplications on ne met pas nécessairement d'espace car en mathématique il suffit de coller deux variables pour signifier une multiplication. On ne met pas d'espace
		+	non plus autour des parenthèses. Par exemple:
		+	a = (b + cd)/4 - kappadelta
		+
		+	Pour faciliter la clarté de lecture d'un bloc d'énoncés on peut mettre plus qu'un espace entre les signes d'égalité de sorte à former une sorte de tableau. Par exemple:
		+
		+	nit = a*exp(b/z);
		+	epsilon = nu*(dudz)2;
		+	iceStress = kappa*dCdx
		+	dragCoef = Cd*U^2;

	== Dois-je documenter en anglais ou en français? ==		== Dois-je documenter en anglais ou en français? ==

@@ Ligne 3 : / Ligne 3 : @@
 == Quel nom donner à ma fonction? ==
-== Quel nom donner à une variable? ==
+== Variables et équations ==
 * Le nom pour les variables qui font directement référence à des équations mathématiques ou à des constantes bien établies devrait s'y apparenter le plus possible et être court (ex. g pour la gravité, u, v, w pour les courants, N pour la concentration de nitrate, etc).
 * Utilisez l'écriture complète des lettres grecques (ex. lambda, phi, rho);
 * Utilisez la barre de soulignement uniquement pour faire référence à une variable qui s'exprime avec un indice (ex: rho_0, sigma_t);
 * Si le code est basé sur des équations tirées d'un article particulier ou d'un livre, respectez le plus possible la convention utilisée dans le document de référence;
 * Exprimez les dérivées avec la lettre 'd' (ex: dt pour le pas de temps ou pour désigner un interval d'échantillonnage, dx pour un pas de grille, dTdx pour le gradient  horizontal de température);
+* Pour les indices d'une grille spatiale utilisez les indices i, j, et k où i et j représentent l'espace horizontale et k l'espace vertical. Si nécessaire, ajouter d'autres lettres à l'indice mais en commençant toujours par i, j, ou k (ex. iGrille1, iGrille2).
 * Pour l'indice temporel, utilisez la lettre n ou, au besoin, une variable qui commence par la lettre n.
 * Pour toutes les variables qui ne font par référence directement à une équation mathématique utilisez un nom de variable qui exprime le plus clairement possible sa fonction tout en restant succinct.
-* Pour toutes les variables qui ne font par référence directement à une équation mathématique utilisez un nom de variable qui exprime le plus clairement possible sa fonction tout en restant succinct.
+* Utiliser le convention du ''lower Camel Case'', c'est-à-dire en séparant les mots qui forment une même variable avec une lettre majuscule mais en commençant par une minuscule (ex. samplingFrequency, fileName).
+* Comme mentionné plus haut, réservez l'utilisation de la barre de soulignement seulement pour faire référence à un indice d'une variable mathématique. Donc, ne pas nommer une variable sampling_frequency mais plutôt respectez le standard du ''lower Camel Case''.
 * Lorsque des variables physiques et des variables biologiques se côtoieent dans une même fonction, les variables biologiques devraient être écrites avec 3 lettres minuscules afin d'éviter certaines confusions (ex. N pour nitrate ou fréquence de Brunt-Vaïsälä).
 Vous trouverez ci-dessous une liste de noms de variables qui respectent les règles précédentes:
@@ Ligne 43 : / Ligne 29 : @@
   S, salt            % salinité (psu)
   SA                 % salinité absolue (calculée avec TEOS-10)
-−
   % Variables biologiques
   nit                % nitrate

@@ Ligne 7 : / Ligne 7 : @@
 === Équations ===
-* Le nom pour les variables qui font directement référence à des équations mathématiques ou à des constantes bien établies devrait s'y apparenter le plus possible et être court (ex. g pour la gravité, u, v, w pour les courants, N pour la concentration de nitrate, etc); Voici une liste de suggestions:
+* Le nom pour les variables qui font directement référence à des équations mathématiques ou à des constantes bien établies devrait s'y apparenter le plus possible et être court (ex. g pour la gravité, u, v, w pour les courants, N pour la concentration de nitrate, etc).
-  % Parameters
+Vous trouverez ci-dessous une liste de noms de variables qui respectent les règles précédentes:
   g                  % accélération gravitationnelle
   ...
@@ Ligne 21 : / Ligne 43 : @@
   S, salt            % salinité (psu)
   SA                 % salinité absolue (calculée avec TEOS-10)
-−
   % Variables biologiques
@@ Ligne 37 : / Ligne 58 : @@
   sil                % silice / silicate
   ...
 == Comment bien rédiger l'aide? ==

@@ Ligne 12 : / Ligne 12 : @@
   % Parameters
   g                  % accélération gravitationnelle
   % Variables physiques
@@ Ligne 20 : / Ligne 21 : @@
   S, salt            % salinité (psu)
   SA                 % salinité absolue (calculée avec TEOS-10)
 * Lorsque des variables physiques et des variables biologiques se côtoieent dans une même fonction, les variables biologiques devraient être écrites avec 3 lettres minuscules afin d'éviter certaines confusions (ex. N pour nitrate ou fréquence de Brunt-Vaïsälä).
@@ Ligne 38 : / Ligne 38 : @@
   ...
-* Utilisez l'écriture complète des lettres grecques (ex: lambda, phi, rho);
+* Utilisez l'écriture complète des lettres grecques (ex. lambda, phi, rho);
 * Utilisez la barre de soulignement uniquement pour faire référence à une variable qui s'exprime avec un indice (ex: rho_0, sigma_t);
@@ Ligne 46 : / Ligne 46 : @@
 * Exprimez les dérivées avec la lettre 'd' (ex: dt pour le pas de temps ou pour désigner un interval d'échantillonnage, dx pour un pas de grille, dTdx pour le gradient  horizontal de température);
-* Pour les indices d'une grille spatiale utilisez les indices i, j, et k où i et j représentent l'espace horizontale et k l'espace vertical. Si nécessaire, ajouter
+* Pour les indices d'une grille spatiale utilisez les indices i, j, et k où i et j représentent l'espace horizontale et k l'espace vertical. Si nécessaire, ajouter d'autres lettres à l'indice mais en commençant toujours par i, j, ou k (ex. iGrille1, iGrille2)
-=== Autres variables ===
+* Pour l'indice temporel, utilisez la lettre n ou, au besoin, une variable qui commence par la lettre n.
-* Pour toutes les variables qui ne font par référence directement à une équation mathématique utilisez une nom de variable qui exprime le plus clairement possible
+* Pour toutes les variables qui ne font par référence directement à une équation mathématique utilisez un nom de variable qui exprime le plus clairement possible sa fonction tout en restant succinct.
-* Utiliser le convention du "lower Camel Case" c'est-à-dire séparez les mots qui forment une même variable avec une lettre majuscule mais en commençant par une minuscule
+* Utiliser le convention du ''lower Camel Case'', c'est-à-dire en séparant les mots qui forment une même variable avec une lettre majuscule mais en commençant par une minuscule (ex. samplingFrequency, fileName).
-* Comme mentionné plus haut, réservez l'utilisation de la barre de soulignement seulement pour faire référence à un indice d'une variable mathématique.
+* Comme mentionné plus haut, réservez l'utilisation de la barre de soulignement seulement pour faire référence à un indice d'une variable mathématique. Donc, ne pas nommer une variable sampling_frequency mais plutôt respectez le standard du ''lower Camel Case'';
 == Comment bien rédiger l'aide? ==

← Version précédente	Version du 1 juin 2017 à 18:49
(Aucune différence)

@@ Ligne 83 : / Ligne 83 : @@
 == Dois-je documenter en anglais ou en français? ==
 == Documents pertinents ==
 Le document [[Media:MatlabStyle1p5.pdf|MatlabStyle5p1]] en est un duquel on pourrait s'inspirer en l'adaptant à l'océanographie.

@@ Ligne 18 : / Ligne 18 : @@
 - Exprimez les dérivées avec la lettre 'd' (ex: dt pour le pas de temps ou pour désigner un interval d'échantillonnage, dx pour un pas de grille, dTdx pour le gradient  horizontal de température);
-- Pour les indices d'une grille spatiale utilisez les indices i, j, et k où i et j représente l'espace horizontale et k l'espace vertical. Si nécessaire, ajouter
+- Pour les indices d'une grille spatiale utilisez les indices i, j, et k où i et j représentent l'espace horizontale et k l'espace vertical. Si nécessaire, ajouter
 d'autres lettres à l'indice mais en commençant toujours par i, j, ou k (ex: iGrille1, iGrille2)