web-dev-qa-db-fra.com

Conventions de dénomination C # pour les acronymes

En ce qui concerne la dénomination C # pour les acronymes, si j'écrivais une bibliothèque liée à l'API Windows, y a-t-il une convention forte vers WindowsApi ou WindowsAPI ou est-ce simplement une préférence personnelle?

c#naming-conventions
68
deltanovember

Il existe une convention qui spécifie les majuscules initiales, les autres minuscules pour tous les acronymes de plus de 2 caractères. D'où HttpContext et ClientID.

58
David Hedlund

" Framework Design Guidelines " 2ème édition par Krzysztof Cwalina et Brad Abrams pp.40-42

3.1.2 Capitalisation des acronymes

[~ # ~] [~ # ~] met en majuscule les deux caractères sur des acronymes à deux caractères, à l'exception du premier mot d'un identifiant en forme de chameau.

System.IO
public void StartIO(Stream ioStream)

[~ # ~] [~ # ~] ne met en majuscule que le premier caractère des acronymes de trois caractères ou plus, à l'exception du premier mot d'un chameau. identifiant en boîtier.

System.Xml
public void ProcessHtmlTag(string htmlTag)

NE PAS mettre en majuscule les caractères des acronymes, quelle que soit leur longueur, au début d'un identifiant en forme de chameau.

33
Sergey Teplyakov

Consultez les directives de dénomination officielles de Microsoft ici Consignes de dénomination

9
Feryt

J'ai entendu dire que vous devriez éviter les abréviations, cela deviendrait alors WindowsApplicationProgrammingInterface.

Plus sérieusement (les gens semblent mal lire ce qui précède, malgré la citation ci-dessous), cette page dit:

Tous les acronymes de trois lettres ou plus doivent être en majuscule, pas en majuscules.

L'API étant considéré comme un acronyme bien connu, le nom WindowsApi est celui à choisir si vous souhaitez suivre les instructions.

8
unwind

Ancienne question, nouvelle réponse.

Selon . NET 4 Capitalisation Rules for Acronymes :

Mettez en majuscule les deux caractères des acronymes à deux caractères, à l'exception du premier mot d'un identifiant en forme de chameau.

Une propriété nommée DBRate est un exemple d'un acronyme court (DB) utilisé comme premier mot d'un identifiant casé Pascal. Un paramètre nommé ioChannel est un exemple d'un acronyme court (IO) utilisé comme premier mot d'un identifiant en forme de chameau.

Ne mettez en majuscule que le premier caractère des acronymes de trois caractères ou plus, à l'exception du premier mot d'un identifiant en forme de chameau.

Une classe nommée XmlWriter est un exemple d'un long acronyme utilisé comme premier mot d'un identifiant casé Pascal. Un paramètre nommé htmlReader est un exemple d'un long acronyme utilisé comme premier mot d'un identifiant en forme de chameau.

Ne mettez en majuscule aucun des caractères des acronymes, quelle que soit leur longueur, au début d'un identifiant en forme de chameau.

Un paramètre nommé xmlStream est un exemple d'un acronyme long (xml) utilisé comme premier mot d'un identifiant en forme de chameau. Un paramètre nommé dbServerName est un exemple d'un acronyme court (db) utilisé comme premier mot d'un identifiant en forme de chameau.

7
ElliotSchmelliot

C'est juste une préférence personnelle (ou organisationnelle). Tant que vous êtes cohérent, tout ira bien.

Le .NET Framework lui-même utiliserait WindowsApi.

3
John Saunders

Sa préférence personnelle. Mais .NET utiliserait WindowsApi. Cela s'apparente à la dénomination de TcpClient.

3
Daniel A. White

Jetez également un œil à FxCop. C'est un utilitaire sympa qui vous aidera avec des problèmes comme celui-ci.

1
Tim Scarborough