Conventions à respecter en C#

Version imprimable

19/03/2011, 19h16
tchize_

Conventions à respecter en C#

Bonjour,

je suis occupé d'apprendre le C# à partir d'un tutoriel de developpez. Cependant, certains points ne sont manifestement abordés par rapport aux bonne pratique et j'aimerais donc savoir quelles sont les bonne pratiques à respecter par rapport à ces points afin d'être facilement maintenable pour d'autres developpeurs C#.

Convention de nommage: Quelles sont les règles à respecter par rapport aux noms des méthodes, des classes, des attributs, des constantes, des propriétés des objets. En java, par exemple, les méthodes & attributs doivent être en lowerCamelCase, les classes en UpperCamelCase, et les constantes en UPPER_CASE, les packages en lowercase. A part pour les constantes, on utilise pas les "_", etc...

Conventions d'organisation des fichiers: Comment doit-on organiser les fichiers dans un projet: un dossier par namespace? un fichier .cs par classe ou plutot un fichier .cs par groupe de classe liées entre-elle? Les fichiers .cs doivent-ils avoir les mêmes noms que les classes à l'intérieur?

Convention sur les namespaces: Travaille-t-on avec des namespaces à plusieurs niveau (en java la recommandation est du style. com.company.module.subpackage.....) ou un seul niveau?

Gestion des dépendances et du build: quels outils sont à disposition pour s'assurer que le build soit reproductible sur n'importe quelle stations, quels outils sont à dispositions pour préciser les modules tiers dont dépendrait l'application? Peux-t-on compiler avec une ligne de commande?
19/03/2011, 21h28
genius4evers
Salut Le Moderateur

dans C# c'est une language de programmaiton Oriente objet,
d'ou on ecrit avant chaque methode public/private/protected , ceci pour les classes qui vont etre utilise avec instance , ou static si appelle du methode par le nom du class.

a propos du nom du methode et son prototype tu peux ecrire
public/private/proteced [type de retour] [nom du methode] (parametre d'entree)
{
}
exemple
Code:

1 2 3 4 public int calculersomme(int a , int b) { int c=a+b; return c }
la language est case senstive tu peux ecrire Calculer , differente que calculer
int i , I ;

il n'y a les contraintes de upper el low pour le nom du class tout marche ,
pour voir s'il ya d'erreur press F6 , Debug F5

a propos fichier .cs et les autres questions je ne connais pas,

Si j'ai bien compris, il veux savoir s'il y a des normes, et non le "minimum à faire pour que ça compile".

Quelques exemples de norme :

Une méthode public
Code:

1 2 3 4 5 public int CalculerSomme(int a , int b) { int c = a + b; return c; }
Une méthode privée
Code:

1 2 3 4 5 private int calculerProduit(int a , int b) { int c = a * b; return c; }
Une propriété
Code:

1 2 3 4 5 6 7 private string _nom; public string Nom { get { return _nom; } set { _nom = value; } }

19/03/2011, 22h00
tchize_

Oui, c'est bien les conventions que je cherche, pas la grammaire du language en lui même, ça je l'ai ;)
19/03/2011, 22h07
olibara
Salut tchize

Personellement j'ai trouvé a peu pres autant de convention qu'il y avait de programmeur et beaucoup de pseudo convention qui sont plus des effets de modes

Cependant je comprends fort bien ton louable souci et personnelement j'ai mis en place quelques conventions de mon cru ou issues de rencontres qui me conviennent autant qu'aux dévellopeurs avec qui je travaille :

Les constantes en majuscules et eventuellement aérées par des _ : MA_CONSTANTE_A

Toutes les types de classes prefixées par C_ (ca permet de mieux les distinguer des instances)
Les Enum prefixées par E_
Les singletons CS_

Les methodes en UpperCamelCase
Les Fields en _lowerCamelCase (avec _ comme prefixe)
Les proppriétés publiques en UpperCamelCase
Les propriétées privées en lowerCamelCase

Passage a la ligne systématique pour les accollades
Code:

1 2 3 4 if (Toto) { Tutu=5; }
J'aere en plaçant des

Code:

// *************************************************

Entre chaques methodes
Et j'utilise pas mal les régions

Pour les NameSpace j'essaye de les limiter et faire en sorte qu'ils soient representatif d'un ensemble homogene contrairement au designer Csharp qui te cree un suffixe de namepace a chaque folder du projet.
Par conttre j'essaye d'organiser le projet en plusieurs folder

- Les classes business
- Les form
- Les classes Common (outils)

etc..

Ah oui j'oubliais quelques erreurs classiques de débutants

1- TOUJOURS faire attention a nommer TOUT DE SUITE les controls d'une form et eviter de laisser faire le travail par le designes

txbPoidsTotal plutot que TextBox1
MonPremierProject au lieu de WindowsFormApplication1
etc..

Et aussi

Eviter tres attentivement de pondre le code dans les handler d'event des controls de form mais placer un appel de methode dans ce handler

Essayer de concenter les traitements metier dans des classe et fichier séparés des Form (meme si la tentation est grande de tout coller dans la form)

Bonne Chance

Allez la Belgique ! ;)
20/03/2011, 00h30
tchize_

Ben je suppose qu'au minimum dans les APIs de bases, il dois y avoir un certains nombre de conventions (du style une interface commence par I) etc :)
20/03/2011, 01h03
giova_fr

j'ajouterai en plus de l'excelente réponse d'olibara je précéde mes propriété de m_ ou s_ selon si la propriété est statique ou non.

Sinon, je recommande au passage un excelent livre à tous les initiés voulant apprendre comment structurer son code pour le rendre facile à maintenir :
[ame="http://www.amazon.com/Agile-Principles-Patterns-Practices-C/dp/0131857258/ref=zg_bs_3962_1/178-3143453-1523555"]Amazon.com: Agile Principles, Patterns, and Practices in C# (9780131857254): Robert C. Martin, Micah Martin: Books@@AMEPARAM@@http://ecx.images-amazon.com/images/I/51aTfzB-dvL.@@AMEPARAM@@51aTfzB-dvL[/ame]
20/03/2011, 01h28
Nathanael Marchand

Dans mon équipe, on a Resharper. En plus du fait qu'il aide pas mal à faire des trucs sympas, il gueule dès que les conventions ne sont pas respectées.
20/03/2011, 07h54
GuruuMeditation

Citation:

Envoyé par Nathanael Marchand

Dans mon équipe, on a Resharper. En plus du fait qu'il aide pas mal à faire des trucs sympas, il gueule dès que les conventions ne sont pas respectées.

+1. C'est très pratique et on peut bien evidemment définir ses conventions. (Et les partager avec son team)
20/03/2011, 09h15
olibara

Je viens d'essayer ReSharper.
Ca avait l'air sympa mais je l'ai quand meme tres vite désinstallé

- Tutoriel inexistant (ou alors trop bien caché)
- Il se greffe completemet sur VS et ralentis tres fort le chargement (j'aurais aimé l'option d'un mode analyse a executer sur demande)

Bref c'est le genre de truc a installer quand on a quelques jours de vacances pour apprendre a s'en servir (pour autant qu'il puisse travailler sur un mode qui n'alourdisse pas completement l'environnement de travail)
20/03/2011, 11h04
tchize_

Donc si je suis bien la conversation, en C# il n'y a aucune convention recommandée par le language, chaque équipe a ses propre conventions et donc au final, personellement, je fait ce que je veux, c'est bien ça?
20/03/2011, 12h00
olibara

Citation:

Donc si je suis bien la conversation, en C# il n'y a aucune convention recommandée par le language, chaque équipe a ses propre conventions et donc au final, personellement, je fait ce que je veux, c'est bien ça?

Si tu veux

Mais le but reste quand meme d'etre facilement lisible voici un lien

http://msdn.microsoft.com/en-us/library/ms229042.aspx

J'oubliais encore :

Je mets toujours l'indentation a deux et en space plutot qu'en tab (le code qui disparait a l'horizon de l'ecran ca me derange toujours)
20/03/2011, 12h11
tchize_

ha ben voilà, c'est le genre de chose que je cherchais, il y a donc bien des recommandations, merci :)
20/03/2011, 18h07
LeCygne

Des règles gravées dans le marbre...
1) Il y a des petites règles qui, si elles sont respectées, peuvent vous faire gagner du temps. Je parle de règles qui sont "gravées", non pas dans le marbre, mais dans Visual Studio. Par exemple :
- Si vous avec un fichier nommé "Ma1ereClasse.cs", que ce fichier ne contient qu'une unique classe nommée "Ma1ereClasse" et que vous renommez ce fichier "Ma2emeClasse.cs", Visual Studio vous proposera de renommer la classe en "Ma2emeClasse" et de faire toutes les mises à jour en correspondance.
  => Donc mieux vaut n'avoir qu'une classe par Fichier.
- Si, dans une classe, une variable commence par une minuscule, (disons... "maVariable") et que vous faite un clique-droit dessus afin de l'encapsuler dans une propriété, Visual Studio vous proposera comme nom pour cette propriété "MaVariable" (Première lettre en majuscule), ce qui est très propre (à mon goût).
  Si, au contraire, cette variable commence déjà par une majuscule, ("MaVariable"), Visual Studio vous proposera "MaVariable1", ce qui est bien moins propre (toujours à mon goût).
  => Donc, première lettre des variables en minuscule, première lettre des propriétés en majuscule.
2) Il y a également des règles observables dans le langage lui même :
- Tous les noms de fonctions commencent par une majuscule
- Tous les noms de classe commencent par une majuscule
- Tous les noms d'interfaces commencent par in "I" majuscule suivi d'une autre majuscule ("IDisposable" par exemple).
3) Plus tout ce que je n'ai pas encore remarqué...
20/03/2011, 18h25
tchize_

en parlant de renommer la classe. Tout ce qui est refactoring (extract interface, extract abstract class, generate constructor using properties, rename method, generate ToString, etc) ce n'est accessible qu'avec les version pro de visual studio? Je suis avec visual C# express et je ne trouve aucun menu de refactoring / génération de code. Et comme ce sont des outils auquel je suis fort habitué, j'aimerais savoir comment les avoir :p
20/03/2011, 18h35
olibara

Salut

Je travaille avec Xpress et la Pro

Il est possible que la pro possede des options en plus mais ca ne m'a jamais vraiment interpellé ni bloqué ce que tu peux faire avec Xpress et déja tres confortable !
20/03/2011, 18h48
tchize_

c'est juste que j'ai pas trouvé les menus de refactoring dans l'express :)
20/03/2011, 18h53
olibara

Ah oui c'est vrai
Il n'y en a pas :roll:

En xpress j'utilise surtout le rename et le generate method automatique
Et c'est déja d'un grand confort !

Et finalement les autres options je ne les emploie que rarement en Pro
20/03/2011, 19h19
LeCygne

Citation:

Envoyé par olibara

Ah oui c'est vrai
Il n'y en a pas :roll:

En xpress j'utilise surtout le rename et le generate method automatique
Et c'est déja d'un grand confort !

Et finalement les autres options je ne les emploie que rarement en Pro

Mais qu'appeles-tu le "rename" ?
Est-ce clique-droit sur la varibale + "Refactoriser" + "Renomer" ?
Parce que si c'est cela, je ne vois pas la différence avec le "refactoring" dont parle tchize_.
20/03/2011, 20h20
tchize_

le refactoring c'est une peux plus que renommer des classes ;) Il y a l'extraction d'interfaces aussi par exemple. La réorganisation de paramètres d'une méthode, l'ajout de paramètres, etc. Efin, je verrais ça au fur et à mesure, j'ai pas fini mes lectures :D
21/03/2011, 09h05
Sehnsucht

Bonjour,

Personnellement en ce qui concerne les conventions de nommage j'ai tendance à me référer à cet article qui est un condensé d'un ouvrage présentant, les "guidelines" (lien vers le livre présent en début d'article).

Cordialement !
21/03/2011, 11h03
kheironn

j'aurais simplement envie de dire de regarder les descriptifs de classe de msdn... on a déjà un bon apperçu du nommage courrant.
pas de notation hongroise, pas de pise de tête :
variable : titiTutuToto
Classe, méthode, prop, etc. TitiTutuToTo
interface : ITitiTutuToto...
constantes... là, on fait d'habitude TITI_TUTU_TOTO... mais ce n'est pas une norme, plus un usage répendu...
de même nombre de gens utilisent le _ pour préfixer ce qui est privé...
21/03/2011, 11h33
Gat-

Citation:

Envoyé par Sehnsucht

Personnellement en ce qui concerne les conventions de nommage j'ai tendance à me référer à cet article qui est un condensé d'un ouvrage présentant, les "guidelines" (lien vers le livre présent en début d'article).

Merci Sehnsucht ! Je ne connais pas la conventions au sujet des Enumerations :

Citation:

Follow class naming conventions. Do not add "Enum" to the end of the enumeration name. If the enumeration represents a set of bitwise flags, end the name with a plural. Examples :
SearchOptions (bitwise flags)
AcceptRejectRule (normal enum)

En y pensant, dans le 1er cas c'est logique vu qu'il est possible de définir plusieurs options avec l'opérateur | ;)
21/03/2011, 11h44
Gat-

J'oubliai... pour ajouter une réponse à la question principale : De mon côté, j'utilise FxCop sur analyser mon code. Un article en parle sur developpez.com ici. Je le trouve sympa et l'analyse se lance uniquement sur demande, donc aucun problème de ralentissement lors du développement.

J'ai tenté d'intégrer FxCop à VS2010 avec FxCopIntegrator mais cela plante sur mon poste :cry:
Du coup, j'ai juste ajouté manuellement le projet FxCop dans l'explorateur de solution de VS2010 et lorsque j'ai envie de lancer l'analyse, je double-clique dessus.