API方法族命名规则

Question

您可以将API方法家族称为（对于程序员来说更容易找到）

• 矩形
• RectangleRounded
• RectangleInflated

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

• 矩形
• RoundedRectangle
• InflatedRectangle

？

在哪里可以找到有关该主题的优缺点讨论？

谢谢。

Answer 1

Microsoft建议（并在.NET框架中使用）以下形式：RoundedRectangle。

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

  

CONSIDER以基类的名称结尾派生类的名称。

Answer 2

很难找到具体谈论您的确切话题的东西，但是我发现了这一点，只是解决了您的问题：

  

  
• 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），因为它更自然地阅读和理解。另外，我认为（和我经常在网上阅读的一样），我们应该尝试使类名尽可能重要。