Comment nommer cette méthode simple?

Question

Tout d’abord, ce n’est pas vraiment une question de programmation. C’est plus une question de "comment satisfaire les conventions de nommage de McConnels?"

J'ai cette application Delphi qui manipule des documents Word. Une des choses que je dois faire est de parcourir tous les signets du document et d’en supprimer certains selon une règle simple: si je travaille actuellement sur un devis, je supprimerai tous les signets dont le nom commence par "cw_orderspecific". Si je travaille sur une confirmation de commande, tous les favoris dont le nom commence par "cw_quotespecific" sont supprimés.

La méthode est en place et tout fonctionne parfaitement, mais j'ai un problème minime. Comment dois-je appeler ma méthode? Le nom actuel ("DeleteBookmarksNotAllowedForCurrentDocumentType") est trop long.

Des suggestions?

Answer 1

DeleteNonRelevantBookmarks?

Answer 2

Modifiez la fonction pour prendre le préfixe à supprimer, puis appelez-le DeleteBookmarksWithPrefix :

DeleteBookmarksWithPrefix("cw_quotespecific")

ou

DeleteBookmarksWithPrefix(otherWorkTypePrefix)

Cela rend le code très lisible et rend la fonction réutilisable dans d'autres circonstances, plutôt que d'être toujours utile pour une tâche très spécifique.

Notez que si vous avez un troisième type de travail, vous pouvez en inverser le sens:

DeleteBookmarksWithoutPrefix(currentWorkTypePrefix)

Answer 3

Combien de temps voulez-vous qu'il soit? Mon premier instinct est de laisser tomber des mots qui ne semblent pas si importants. Comme DeleteBookmarksNotAllowedForDocumentType, DeleteBookmarksNotAllowedForDocument ou simplement DeleteBookmarksNotAllowed. Bien que je préfère probablement quelque chose comme DeleteInvalidBookmarks. Bien sûr, cela ne fonctionne que s'il n'y a pas d'autres méthodes qui suppriment les signets selon des règles différentes.
Ou si vous souhaitez modifier votre méthode de fonctionnement, je le rendrais plus générique en donnant le préfixe en tant que paramètre, le nom serait alors plus simple.

Answer 4

Utilisez des acronymes? Définissez dans les commentaires que CDT est "Type de document actuel", et vous obtiendrez DeleteBookmarks_NotAllowedForCDT . Assez court.

Answer 5

Que diriez-vous de DelBookmarksStartingWith ? C'est assez clair et exprime l'intention.