Quiconque de trouver de nommage des classes et des méthodes de l'une des parties les plus difficiles dans la programmation?

Ce que vous faites maintenant est très bien, et je vous recommande de vous en tenir à votre cours syntaxe: la

contexte + verbe + comment

J'utilise cette méthode pour le nom de fonctions/méthodes, SQL stockées procs, etc. En accord avec cette syntaxe, il gardera votre Intellisense/Code Volets beaucoup plus soigné. Donc, vous voulez EmployeeGetByID() EmployeeAdd(), EmployeeDeleteByID(). Lorsque vous utilisez un plus grammaticalement correcte de la syntaxe comme GetEmployee(), AddEmployee() vous verrez que cela devient vraiment salissant si vous avez plusieurs est dans la même classe que sans rapport avec les choses vont être regroupés.

J'apparente cela à de nommage des fichiers avec des dates, vous voulez dire 2009-01-07.journal pas 1-7-2009.journal parce que, après vous avez un tas d'entre eux, l'ordre devient totalement inutile.

Une leçon que j'ai apprise, c'est que si vous ne pouvez pas trouver un nom pour une classe, il y a presque toujours quelque chose de mal avec cette classe:

• vous n'en avez pas besoin
• il en fait trop

Thread 1:

function programming_job(){
    while (i make classes){
         Give each class a name quickly; always fairly long and descriptive.
         Implement and test each class to see what they really are. 
         while (not satisfied){
            Re-visit each class and make small adjustments 
         }
    }
}

Filetage 2:

while(true){
      if (any code smells bad){
           rework, rename until at least somewhat better
      }
}

Il n'y a pas de Fil.le sommeil(...) nulle part ici.

Le livre Le Code Complet de Steve Mcconnell a un beau chapitre sur le nommage des variables/classes/fonctions/...

En fait je viens d'entendre cette citation hier, par le biais de la Signal contre le Bruit blog à 37Signals, et j'ai certainement d'accord avec elle:

"Il y a seulement deux choses dures dans l'Informatique: l'invalidation du cache et de nommer les choses."
— Phil Karlton

Convenu. Je tiens à garder mes noms de types et variables aussi descriptif que possible sans être trop horriblement long, mais parfois il y a juste un certain concept que vous ne pouvez pas trouver un bon mot pour.

Dans ce cas, il m'aide toujours à demander à un collègue pour l'entrée - même s'ils ne sont pas en fin de compte aider, il est généralement utile de moi pour au moins l'expliquer à haute voix et de poser mes roues tournent.

Plus que juste la dénomination d'une classe, la création d'un package approprié de la structure peut être difficile, mais gratifiant défi. Vous devez envisager de séparer les préoccupations de vos modules et comment ils se rapportent à la vision de l'application.

Envisager la mise en page de votre application:

• App
  • VendorDocRequester (lire à partir du service web et de fournir des données)
  • VendorDocViewer (utiliser le demandeur à fournir vendeur docs)

Je me risquerais à deviner qu'il y a beaucoup de choses à l'intérieur de quelques classes. Si vous étiez à refactoriser ce dans une plus MVC-identifiés approche, et de permettre aux petites classes pour gérer des tâches, vous pourriez vous retrouver avec quelque chose comme:

• App
  • VendorDocs
    • Modèle
      • Document (objet ordinaire qui contient des données)
      • WebServiceConsumer (deal avec nitty gritty en web service)
    • Contrôleur
      • DatabaseAdapter (poignée de persistance à l'aide de l'ORM ou autre méthode)
      • WebServiceAdapter (utiliser Consommateur de saisir d'un Document et de le coller dans la base de données)
    • Vue
      • HelpViewer (utiliser DBAdapter à cracher la documention)

Votre classe les noms de compter sur l'espace de noms de fournir contexte complet. Les classes elles-mêmes peuvent être intrinsèquement liées à l'application sans avoir besoin de préciser explicitement de la sorte. Les noms de classe sont plus simples et plus faciles à définir en tant que résultat!

Un très important suggestion: s'il vous plaît ne vous une faveur et de ramasser une copie de, Tête la Première, les Modèles de Conception. C'est un fantastique, facile-livre de lecture qui vous aidera à organiser votre application et à mieux écrire le code. Appréciant les modèles de conception vous aidera à comprendre que beaucoup de problèmes ont déjà été résolus, et vous serez en mesure d'intégrer les solutions dans votre code.

En bref:

Je suis d'accord que les bons noms sont importants, mais je ne pense pas que vous avez à les trouver avant de mettre en œuvre à tous les coûts.

Bien sûr de son mieux pour avoir un bon nom droite dès le début. Mais si vous ne pouvez pas venir avec un en 2 minutes, le changement de nom plus tard coûtera moins de temps et est le bon choix à partir d'une productivité point de vue.

Long:

Généralement, c'est souvent pas la peine de penser trop longtemps sur un nom avant de mettre en œuvre. Si vous implémentez votre classe, en le nommant "Toto" ou "Dsnfdkgx", tandis que la mise en œuvre de vous voir ce que vous devriez avoir un nom.

Surtout avec Java+Eclipse, le fait de renommer les choses n'est pas de douleur, comme il soigneusement les poignées de toutes les références dans toutes les classes, vous avertit des collisions de nom, etc. Et aussi longtemps que la classe n'est pas encore dans le référentiel de contrôle de version, je ne pense pas qu'il ya quelque chose de mal avec le renommage 5 fois de suite.

Fondamentalement, c'est une question de la façon dont vous pensez à ce sujet le refactoring. Personnellement, je l'aime, si elle agace mes coéquipiers parfois, comme ils le croient en jamais toucher un système en cours d'exécution. Et de tout ce que vous pouvez restructurer, en changeant les noms de est un de la plus inoffensive des choses que vous pouvez faire.

Il y a seulement un nom judicieux pour la classe:

HelpRequest

Ne laissez pas les détails de l'application, vous distraire de la signification.

Je m'en tiens à l'essentiel: VerbNoun(arguments). Exemples: GetDoc(docID).

Il n'y a pas besoin d'obtenir la fantaisie. Il sera facile de comprendre une année à partir de maintenant, si c'est vous ou quelqu'un d'autre.

Je suis d'accord que la nomenclature est un art. Il devient un peu plus facile si votre classe est à la suite d'un certain "assorti, modèle" (usine, etc).

Nope, le débogage est la chose la plus difficile chose pour moi! 🙂

La langue que vous utilisez pour décrire le problème, c'est la langue que vous devriez utiliser pour les variables, méthodes, objets, classes, etc. Vaguement, les noms correspondent à des objets et des verbes match méthodes. Si vous êtes en manque de mots pour décrire le problème, il manque aussi une compréhension complète (spécification) du problème.

Si c'est juste le choix entre un ensemble de noms, alors il devrait être guidé par les conventions que vous utilisez pour construire le système. Si vous êtes un nouveau spot, découvert par les précédentes conventions, alors c'est toujours la peine de dépenser un peu d'effort à essayer de les étendre (correctement, de façon constante) pour couvrir cette nouvelle affaire.

En cas de doute, dormir là-dessus et choisissez la première et la plus évidente nom, le lendemain matin 🙂

Si vous vous réveillez un jour et de réaliser que vous aviez tort, alors changez-le immédiatement.

Paul.

BTW: Document.fetch() est assez évidente.

N'oubliez pas de motifs de conception (et pas seulement du GoF) sont un bon moyen de fournir un vocabulaire commun et leurs noms doivent être utilisés chaque fois que l'on s'adapte à la situation. Cette volonté d'aider les nouveaux arrivants qui sont familiers avec la nomenclature de comprendre rapidement l'architecture. C'est cette classe que vous travaillez sur censés agir comme un Proxy, ou même une Façade ?

J'ai vraiment l'impression de vous. Et je ressens votre douleur. Chaque nom, je pense que de semble juste de la foutaise pour moi. Tout cela semble si ouverte et si je veux finalement apprendre à injecter un peu de flair et de la créativité dans mes noms, les rendant reflètent vraiment ce qu'ils décrivent.

Une suggestion que j'ai à faire est de consulter un dictionnaire des synonymes. Word est un bon un, tout comme Mac OS X. Qui peut vraiment m'aider à obtenir ma tête des nuages et me donne un bon point de départ, ainsi qu'une source d'inspiration.

Je ne trouve pas ça difficile. Si vous ne pouvez pas nom il alors peut-être que vous n'en avez pas besoin. Le mieux est de votre design le plus il sera facile de nommer les choses que votre création ne.

Maintenant les variables temp, c'est une autre histoire. 🙂

Je ressens votre douleur. :/

Je souhaite qu'il y avait un outil pour l'analyse de code source en conjonction avec un dictionnaire de données (un fichier décrivant les différentes variables /les noms de méthode, je pense un peu comme javadoc), de sorte que vous pouvez écrire du code comme ceci:

class Battery 
{
   double I; //current
   double T; //temperature
   double V; //voltage
   double Q; //charge

   void update(double Inew, double dt) { I = Inew; Q += I*dt; }
   //... etc ...
};

et le code de l'examen de l'outil pourrait faire un certain nombre de choses différentes pour le rendre plus facile à afficher le code dans son contexte, y compris l'affichage des rappels que I = courant (par exemple, dans un volet sur le côté droit de la fenêtre pour afficher les définitions de variables/sémantique/commentaires pour la placer dans le code en cliquant sur les), ou même vous permettre de faire "virtuel refactoring" où, comme un code examinateur vous pouvez renommer quelque chose à votre goût pour des raisons de lisibilité/affichage raisons sans changer le code stocké sur le disque.

Autant que j'aime l'auto-décrire les noms, je déteste lire des choses comme BatteryFilteredCurrentInMilliamps. Souvent dans les systèmes embarqués nous cherchons à modéliser des objets en se basant sur les équations algébriques et des noms tels que dans des équations très compliquées. (d'un autre côté, un "I" avec un chapeau sur le dessus et un indice "d" et un symbole "*" est plutôt déroutant.)

Je suis un EE /ingénieur systèmes abord avec de légères logiciel de responsabilités et à la fin, j'ai vraiment ne se soucient pas ce qu'est une variable nommée aussi longtemps que j'ai un moyen commode de dire ce que c'est, et de la cartographie sur mon propre modèle interne du système contrôlé.

Une autre raison pourquoi chaque développeur de logiciels devraient avoir écrit et compétences en communication.

PD: je crois qu'un vaste vocabulaire est également important.

Si 8 personnes sur 10 le comprendre, alors vous pouvez supposer qu'il est compréhensible et lisible et clair. Il y aura toujours ces 1 ou 2 nit cueilleurs qui va essayer de panne et pour aucune autre raison que le fait qu'ils sont petits.

Il se sent généralement très naturel pour moi. Je fais toujours très court méthodes, jamais plus de 6 lignes de code Smalltalk (automatiquement mis en forme), donc je n'ai pas vraiment de mal à dire ce que cette méthode est d'environ.

Parfois les noms de classe sont difficiles, parce que le mot que je veux c'est choisir de l'utiliser quelque part dans le système, parce que parfois le même mot a des significations différentes dans des contextes différents. Je souhaite que, dans ces cas, certains comme Wikipédia syntaxe serait autorisé, de sorte que je pouvais le nom de ma classe "Task (tâche)". Jusqu'à ce qui est légal, je fais un grand style allemand mot de: ToDoListItemTask. Vous l'avez deviné: Ma méthode de noms peut être très long, trop. Mais je pense qu'ils sont lisibles.

Donc, dans votre cas, votre classe est un "getter", ou retriever, ou quoi que ce soit. Êtes-vous sûr que ce doit être modélisé en classe? Ne serait pas plutôt le vendeur doc être en mesure de demander lui-même? Quelque chose comme vendorDoc.la demande(source); serait plus facile de nom, n'est-ce pas?

acclamations,

niko

Résumer la méthode/classe dans "Un Mot", répondant à ce qu'il signifie pour?
Et il ne devrait pas être l'équivalent de ce mot.