我如何命名这个简单的方法？

Question

首先，这不是真正的编程问题。这更像是一个“我如何满足McConnels命名惯例？”的问题。

我有这个操作word文档的Delphi应用程序。我需要做的一件事是运行文档中的所有书签，并根据一个简单的规则删除其中的一些：如果我目前正在处理报价，我将删除名称以“cw_orderspecific”开头的所有书签。如果我处理订单确认，我将删除名称以“cw_quotespecific”开头的所有书签。

该方法已经到位，一切都运行良好，但我有一个小问题。我该怎么称呼我的方法？当前名称（“DeleteBookmarksNotAllowedForCurrentDocumentType”）太长。

有什么建议吗？

Answer 1

更改函数以删除前缀，并将其命名为DeleteBookmarksWithPrefix：

DeleteBookmarksWithPrefix("cw_quotespecific")

或

DeleteBookmarksWithPrefix(otherWorkTypePrefix)

这使得代码非常易读，并且它使该函数在其他情况下可重用，而不是仅对一个非常特定的任务有用。

请注意，如果您有第三种工作类型，您可能想要扭转它的意义：

DeleteBookmarksWithoutPrefix(currentWorkTypePrefix)

Answer 2

DeleteNonRelevantBookmarks？

Answer 3

你想要多短？我的第一直觉是放弃一些看起来不那么重要的话。像DeleteBookmarksNotAllowedForDocumentType，DeleteBookmarksNotAllowedForDocument，或者只是DeleteBookmarksNotAllowed。虽然我可能更喜欢DeleteInvalidBookmarks之类的东西。当然，只有在没有其他方法可以通过不同的规则删除书签时，这才有效 或者，如果您愿意更改方法函数的方式，我会通过将前缀作为参数使其更通用，然后命名会更简单。

Answer 4

使用首字母缩略词？在评论中定义CDT是“当前文档类型”，您将获得DeleteBookmarks_NotAllowedForCDT。足够短。

Answer 5

DelBookmarksStartingWith怎么样？它很清楚，表达了意图。