Règle de codage

[ghost]

Il faudrait qu'on se mette d'accord sur des règles de codage pour le nouveau code en Scala (pour faciliter la future maintenance). Je propose les points suivants:

• Un en-tête pour chaque fichier avec les informations suivante: nom de l'auteur, fonction du fichier, autres informations pertinentes.
• Un en-tête pour chaque méthode: description de la méthode, paramètres, valeur de retour.
• Nom des variables, des méthodes explicites, des classes et des packaes explicites.
• Ajouter des commentaires pour les parties de code qu'il n'est pas évident de comprendre (même avec des noms de variables et méthodes explicites )

N'hésitez pas à rajouter d'autres points

[davidonlaptop]

Voici un lien vers le format de la scaladoc: https://wiki.scala-lang.org/display/SW/Tags+and+Annotations

2015-06-15 8:33 GMT-07:00 singemanator notifications@github.com:

Il faudrait qu'on se mette d'accord sur des règles de codage pour le nouveau code en Scala (pour faciliter la future maintenance). Je propose les points suivants:

-

Un en-tête pour chaque fichier avec les informations suivante: nom de l'auteur, fonction du fichier, autres informations pertinentes.

Un en-tête pour chaque fonction du fichier: input, output, but de la fonction etc.

Nom des variables, des méthodes explicites, des classes et des packaes explicites.

N'hésitez pas à rajouter d'autres points

— Reply to this email directly or view it on GitHub https://github.com/GELOG/adam-ibs/issues/42.