Discussion :

[tchize_]

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?

[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 :

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

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,

[PatteDePoule]

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 :

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

1
2
3
4
5
public int CalculerSomme(int a , int b)
{
	int c = a + b;
	return c;
}

Une méthode privée

Code :

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

1
2
3
4
5
private int calculerProduit(int a , int b)
{
	int c = a * b;
	return c;
}

Une propriété

Code :

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

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

[tchize_]

Oui, c'est bien les conventions que je cherche, pas la grammaire du language en lui même, ça je l'ai

[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 :

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

1
2
3
4
if (Toto)
{
  Tutu=5;
}

J'aere en plaçant des

Code :

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

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

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 !

[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

[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]

[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.

[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é...