在撰写评论时，将某种类型变为复数形式的好方法是什么？

在撰写评论时，我有时会发现自己需要在撰写评论时用复数形式讨论类型（类，结构等），例如：

/*
 * getThings
 *    Get a list of --> Things <-- from somewhere.
 */
Thing *getThings(void);

问题是，类型名称是单数（即Thing ），但是我想在复数中评论它们。

如果我说Things ，它会向读者建议它谈论的是一种称为“ Things的类型，事实并非如此。 如果我说Thing's ，它看起来很尴尬，因为它在语法上不正确（它可能是占有欲，也可能是“事物是”，而不是复数形式）。 我可以谈论这个问题并说出a list of Thing items

在编写复数类型时，遵守什么是一个很好的惯例？

---

那么，根据您使用的文档系统，您可以使用特殊的语法来包装类型的名称，并将其放在它的外面。 例如：

.NET XML评论

Get a list of <see cref="Thing"/>s from somewhere.

doxygen C / C ++评论

Get a list of link Thing endlink s from somewhere.

对于doxygen变体不是100％确定的，但它应该是这样的。

如果你没有使用特定的文档系统，因此没有特别的评论，我会做一些事情：

Get a list of [Thing]s from somewhere.

或者您可以使用（）或{}，具体取决于偏好...

---

我会在括号中使用's'。

/* Get a list of Thing(s) from somewhere */

链接地址: http://www.djcxy.com/p/2445.html

上一篇: What's a good way to make a type a plural when writing comments?

下一篇: What's the most Cocoaish way to show that a text field is invalid?