好的命名约定应该尽量减少任何给定变量、类、方法或函数可使用的名称数量。如果只有一个可能的名字，你永远不会有困难记住它。

对于函数和单例类，我仔细检查函数，看看它的基本功能是否将一种东西转换为另一种东西。我对这个术语的使用非常宽松，但你会发现你写的大量函数本质上是以一种形式的东西产生另一种形式的东西。

在您的例子中，这听起来像是您的类将Url转换为Document。这样想有点奇怪，但完全正确，当你开始寻找这个模式时，你会到处看到它。

当我找到这个模式时，我总是将函数命名为xFromy。

因为您的函数将Url转换为Document，所以我将它命名为Document

DocumentFromUrl

这种模式非常普遍。例如:

atoi -> IntFromString
GetWindowWidth -> WidthInPixelsFromHwnd // or DxFromWnd if you like Hungarian
CreateProcess -> ProcessFromCommandLine

你也可以使用UrlToDocument如果你更喜欢这个顺序。不管你说的是xFromy还是yTox，可能都是个人喜好的问题，但我更喜欢From顺序，因为这样函数名的开头就已经告诉了你它返回的类型。

选择一个惯例并坚持下去。如果注意在xFromy函数中使用与类名相同的名称，就会更容易记住所使用的名称。当然，这种模式并不适用于所有情况，但它确实适用于您编写的可以被认为是“功能性”的代码。

上个月我刚刚写了一篇关于命名惯例的文章:http://caseysoftware.com/blog/useful-naming-conventions

要点是:

verbAdjectiveNounStructure -结构和形容词作为可选部分

对于动词，我坚持使用动作动词:保存、删除、通知、更新或生成。偶尔，我也会使用“进程”一词，但只是专门指队列或工作积压。

对于名词，我使用与之交互的类或对象。在web2project中，这通常是任务或项目。如果是Javascript与页面交互，则可能是body或table。关键在于代码清楚地描述了与之交互的对象。

该结构是可选的，因为它对该情况是惟一的。列表屏幕可能会请求List或Array。在web2project的项目列表中使用的核心函数之一就是getProjectList。它不修改底层数据，只修改数据的表示形式。

The adjectives are something else entirely. They are used as modifiers to the noun. Something as simple as getOpenProjects might be easily implemented with a getProjects and a switch parameter, but this tends to generate methods which require quite a bit of understanding of the underlying data and/or structure of the object... not necessarily something you want to encourage. By having more explicit and specific functions, you can completely wrap and hide the implementation from the code using it. Isn't that one of the points of OO?

这是有编码标准的原因之一。有一个标准往往有助于在需要时想出名字。它有助于解放你的思想，让你去做其他更有趣的事情!(-):

我建议阅读Steve McConnell的《Code Complete》(Amazon链接)的相关章节，其中介绍了一些有助于提高可读性甚至可维护性的规则。

HTH

欢呼,

Rob

我学到的一个教训是，如果你找不到一个类的名字，那么这个类几乎总是有问题:

你不需要它 它做的太多了

如果10个人中有8个人理解它，那么你就可以放心地认为它是可以理解、可读和清晰的。总会有那么一两个挑剔的人，他们会毫无理由地找你的茬，只因为他们太小气。

该类只有一个合理的名称:

HelpRequest

不要让实现细节分散了你对意义的注意力。