Conventions de dénomination: instructions pour l'utilisation des verbes / noms et de la grammaire anglaise

StackOverflow https://stackoverflow.com/questions/412839

  •  03-07-2019
  •  | 
  •  

Question

Quelqu'un peut-il m'indiquer un site ou me donner une idée de la manière dont vous allez choisir des noms pour les interfaces, les classes et peut-être même des méthodes et des propriétés relatives à ce que fait cet objet ou cette méthode?

Ceci est spécifiquement destiné au développement Microsoft, donc Java-esque " doGet " et cetera n'est pas vraiment utilisé, cependant certaines règles générales qui doivent séparer les barrières linguistiques doivent (je l'aurais pensé) exister.

Un exemple pourrait aider: J'ai 4 choix de noms pour une interface: 

IGroupedItem
IGroupableItem
IDataEntity
IGroupedEntity

Ils contiennent tous un adjectif et le nom, ou simplement un nom. En regardant le framework .NET, il semble y avoir une sorte de jeu de règles pour cela, pour la cohérence? Outre les verbes évidents pour les méthodes.

Modifier: Bien que cet exemple soit une interface, je ne le limite pas à de simples interfaces. La directive générale est que les classes sont des noms, des méthodes verbes, des noms de propriétés. Je suppose que ce que je veux dire, c'est le choix du synonyme. Lance " Entity " mal partout

Était-ce utile?

La solution

Consultez les articles MSDN pour l'attribution de noms. des lignes directrices. En bref:

  • Utilisez des noms pour les noms de classe et les noms de propriété (c'est évident)
  • Pour les noms d'interface, commencez par I et utilisez des noms et / ou des adjectifs pour décrire le comportement
  • Utilisez des verbes pour les noms de méthodes afin de décrire l'action

Par exemple, IGroupableItem.

Autres conseils

Les interfaces sont des tâches qu'une classe est capable de faire. Ce n'est pas ce , mais ce qu'il peut faire . 

IGroupableItem

Les autres noms décrivent ce qui est ou est trop vague pour être utile.

Plus précisément, "IDataEntity". est en grande partie sans signification. Après tout, tout est une entité de données.

MSDN publie un article dans Consignes de dénomination d'interface cela peut vous aider. Si vous souhaitez connaître les conventions de dénomination des éléments autres que les interfaces, ainsi que de nombreuses autres consignes de conception et de conception, vous pouvez également trouver ces informations sur MSDN.

Ceci est identique à la réponse de Spodi, mais à la consignes de création de classe de MSDN Les développeurs de bibliothèques sont pour la plupart excellents et couvrent l'attribution de nom , etc. , beaucoup plus.

Il y a un bel article Donner un mauvais code à un faux par Joel Spolsky. Il parle de convention de nommage pas très populaire, mais très pratique.

Outre les directives MSDN, il existe un document sur les normes de codage C # de IDesign de Juval Lowy, à savoir très utile (je ne sais pas si / en quoi cela diffère de MSDN).

Normes de codage C #

Licencié sous: CC-BY-SA avec attribution
Non affilié à StackOverflow
scroll top