naming-conventions - 过滤器命名约定

Question

我有一个 mysql 函数，它接受字符串作为输入并仅返回字母数字字符。

例如，

101-FFKS 99S-5 将输出 101FFKS99S5。

它被称为alphanum，它的描述性不太强。

我正在考虑类似 alphanum_filter 或 punctuation_filter 的东西。

约定的约定是什么？您要过滤掉的东西，还是留下的东西？

一些谷歌搜索没有产生任何有用的结果。

Answer 1

我认为编程中没有任何商定的约定。

请注意，对于放置在“过滤器”附近的内容，有三个而不是两个选项:

• 您要过滤掉的内容，
• 你还剩下什么
• 以及两者的组合，即进入过滤器的物质。

事实上，我认为一般来说，当您在英语中看到“过滤器”附近的单词时，您会认为该单词将被放入过滤器中。
请注意，虽然“空气滤清器”、“水滤清器”、“机油滤清器”和“燃油滤清器”似乎是指过滤后剩下的东西，但我坚信在它们之前都有一个隐含的“未过滤”。

然而，也有一些名词真正包含“你剩下的东西”，例如“高通滤波器”或“红色滤波器”，以及包含“你正在过滤的东西”的名词out”，例如“垃圾邮件过滤器”。

因此在任何情况下它都可能是模棱两可的。
就我个人而言，乍一看，我认为该单词将被过滤掉，因此我对 punctuation_filter 更满意，但这可能是主观的。
因此，最好找到一个不太模糊的名称(尽管在某些情况下，使用模糊的名称是可以的，让每个程序员通过查看其源代码来理解它的作用；更重要的是保持一致，你肯定不会这样做)想要一个 punctuation_filter 过滤掉标点符号，以及一个 num_filter 在同一代码中只允许数字通过)。

更清晰的名称可能是 LeaveOnlyAlphanums。
是的，它是一个断言而不是名词，但您可以使用的唯一明确的名词短语可能是 FilterThatLeavesOnlyAlphanums 或 ThingThatLeavesOnlyAlphanums。

另一个想法是使用FilterOut 而不是简单的Filter。尽管这也是一个断言，但这是明确无误的。

<小时/>

如果您正在寻找编程领域具有某种权威的东西，我发现 The Art of Readable Code 中明确提到 filter 是不明确的。 .