根据流行度命名功能

Question

您需要两个功能：
1.从DB中检索纯文本 2.基于1，检索富文本 - 使用新行，字体样式等。

您希望函数2比函数1使用得多。

你会命名1个text（）和2 - rich_text（），或者你会使用更简单的文本（）作为2的名称，因为它预计会更受欢迎并使用类似于plain_text（）的东西吗？

更一般的问题是 - 在命名时你是否考虑函数的预期“流行度”？

Answer 1

不，我不认为功能的受欢迎程度。最好为两个函数都有描述性名称（例如，一个是plain_text()，一个是rich_text()。）

我认为最好为所有函数使用相对特定的名称，因为使用更通用的名称1.）不会让用户过多地了解函数通过读取名称而做的事情。）导致混乱。

当然，你如何命名你的功能是你的选择：我只是建议你给它们一些描述性的名字，并且你要一致地命名它们（和命令参数）。

我讨厌的只是使用API​​进行编程，其中每个函数名称都很简短而且神秘（PHP的字符串函数就是这样，即使我已经习惯了它 - strstr和strtok他们所做的事情并不是直观的名字。

Answer 2

如果代码将被广泛使用，有时候值得考虑流行度。自然语言中的常用词往往很短。

但是，除非您认为自己正在编写下一个UNIX，否则最好使名称具有描述性，而不用担心长度。

我选择getPlainText()和getRichText()。

Answer 3

根据经验，我总是根据他们的行为来松散地命名我的功能。如果我在你的鞋子里，我会将第一个功能命名为retrieve_plain_text()，并将其命名为retrieve_rich_text()。我现在可以浏览一下函数名称，并立即对该函数应该做什么有一个基本的了解：检索（从某些东西，在这种情况下是数据库）plain / rich（类型）文本。