API 方法族命名规则

Question

你会调用一系列 API 方法（程序员更容易找到）

• 矩形
• 圆角矩形
• 矩形膨胀

或（用流利的英语更容易阅读）

• 矩形
• 圆角矩形
• 膨胀矩形

?

我在哪里可以找到关于这个主题的利弊讨论？

谢谢。

Answer 1

很难找到专门谈论您的确切主题的东西，但我找到了这个，它只是解决了您的问题：

• ThingAbstract：“抽象”后缀。不自然的语言。显示在文件列表中的 ThingInterface 旁边。
• AbstractThing：“抽象”前缀。自然语言。与文件列表中的 ThingInterface 相去甚远。

_{来源： https://www.drupal.org/project/coding_standards/issues/1567920}

除了提到自然性之外，它还谈到了列出顺序，这有助于理解项目的结构（所有艰难的子文件夹都应该弥补这一点）。

这是关于 stackoverflow 的另一个答案，其中指出

对于类的名称，通常会在类名称前加上特化 [..]

_{来源：The C# namespace and class/sub-class naming conventions when the top namespace contains the base class and inner namespaces contain sub-classes}

---

我认为，这主要是基于意见，我个人更喜欢第二种方式（RoundedRectangle），因为它更自然地阅读并因此易于理解。另外我认为（正如我经常在网上阅读的那样），我们应该尽量使类名尽可能重要。

Answer 2

Microsoft 推荐（并在 .NET 框架中使用）格式：RoundedRectangle。

MS 提供了非常有用的Naming Guidlines 文档。您可以在类、结构和接口的名称一章中找到以下内容：

考虑以基类的名称结尾派生类的名称。