2009-05-19 4 views
1

Sur episode #162 of Hanselminutes ils parlaient PowerShell, mais surtout autour de 04h50 ils ont mentionné que PowerShell utilisé quelque chose appelé The Common Engineering Criteria d'avoir une norme sur les mots à utiliser lors de l'élaboration de nouveaux modules pour cela..NET: Common programmation mots-clés dictionnaire

Je ne trouve pas de dictionnaire concret sur les mots recommandés à travers cette page.

Est-ce que quelqu'un connaît une bonne ressource pour les mots-clés normalisés à utiliser lors du développement de .NET (C# dans ce cas)? Je parle noms et verbes.

Un bon point qu'ils ont soulevé dans le podcast était que vous pouviez presque toujours deviner ce que l'objet et les méthodes est nommé.

Ceci afin d'éviter de ne pas savoir que l'un de ces pour sélectionner:

object.GetInfo(); 
object.FetchInfo(); 
object.CreateInfo(); 
object.RetrieveInfo(); 

MISE À JOUR: J'ai trouvé un bon départ, a list of standardized verbs used in PowerShell, mais ils semble que les normes utilisées dans le .NET Framework.

+2

Utilisez le mot qui décrit le mieux ce que la méthode est destinée à faire ... object.ObtainByCircuitousMeansTheInfo(); – Shog9

+0

Oh merci, j'ai oublié la structure object.ObtainInfo() ... merci d'ajouter un autre verbe au désordre. –

+0

qu'en est-il de object.Info qui est implémenté par les propriétés ;-) – Dario

Répondre

3

Je vérifierais Microsoft's Guidelines for Names:

directives Naming donnent des indications sur la sélection des identificateurs appropriés pour les éléments qui composent les bibliothèques de classe , y compris les assemblages , types, espaces de noms membres et paramètres. Le choix des identifiants conformes à ces directives améliore la facilité d'utilisation de votre bibliothèque et encourage les utilisateurs à croire que votre bibliothèque n'exigera pas l'apprentissage d'un nouveau jeu de conventions .

La plupart d'entre vous intéresser serait très probablement la section intitulée Names of Type Members:

Noms des méthodes

Ne donnez les méthodes qui sont les verbes ou phrases verbales.

méthodes agissent sur des données En règle générale, si un verbe en utilisant pour décrire l'action de la méthode facilite aux développeurs de comprendre ce que la méthode fait. Lorsque l'on définit l'action effectuée par la méthode, faites attention à un choix qui offre une meilleure visibilité du point de vue du développeur. Ne ne pas sélectionner un verbe qui décrit comment la méthode fait ce qu'elle fait; dans d'autres mots, n'utilisez pas les détails d'implémentation pour le nom de votre méthode.

Au-delà c'est vraiment à vous.Vous avez beaucoup de liberté ici, mais une bonne règle consiste à imiter le style des noms que vous trouvez dans le framework .NET pour que vos types et vos membres "se sentent chez eux".

+0

Assez près, mais pas vraiment ce que je cherchais. –

Questions connexes