文档应该如何引用类型名称的复数形式？
在评论或记录代码时，我经常发现引用一个类型名称的复数是有用的，但我不确定什么是最可读和最不明确的方式来做到这一点。 例如，如果我有一个名为Dog的类，那么可以自然地说“所有狗都有woof（）方法”。 但是如果我也有一个名为“Dogs”的类可以包含Dog类型的多个实例呢？ 说“狗”是指涉及多种类型的狗而不是单一类型的狗时，会混淆吗？
请注意，我不是在问类型命名约定应该是什么，而是如何引用代码外部的注释或文档中的类型。
我发现英语语法规则有时候可以用来形成复数形式。 例如，“做和不做”或“我得到了所有的A”，但我认为“所有狗都有woof（）方法”并不正确。 这可能看起来像一个愚蠢的问题，但多年来它多次让我感到悲伤。
这显然是基于意见的，但我认为all Dogs have都很混乱。 我宁愿看到类别名称的排版方式不同或以某种方式引用，例如， all 'Dog's have或者如果空间允许， all Dog instances have更清晰（更易于阅读）。
从语言角度来看，我期望一个简单的撇号就足够了。 例如，根据芝加哥风格手册，复数字母的规则如下：
用作单词的大写字母，用作名词的数字和缩写通常通过添加s来形成复数。 为了帮助理解 ，小写字母使用撇号和s形成复数形式 。
推断，在含糊不清的情况下允许使用撇号，这在我看来是一种语法正确的解决方案。 例如，字母A的多个实例也将被称为A's。
另外，有些人认为用撇号来占有这种方式是不可取的，所以如果你从不以占有形式引用狗的话，就不会有任何混淆：
所以，总之，“汽车的天线”很好，“汽车的天线”仍然会受到一些人的青睐，“天线”也很好，尽管KJV会使用“它的天线”。
在英语堆栈交换中询问这个问题可能是值得的。 从快速浏览大多数关于复数的语法规则都是比较特殊的（例如，人名），并不直接应用于类名。
链接地址: http://www.djcxy.com/p/14947.html上一篇: How should documentation refer to the plural of a type name?
下一篇: What is the syntax for writing comments in build.gradle file?