在撰写评论时，将复数形式设为复数是一种好方法？

Question

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

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

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

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

写多种类型时，坚持什么是好的约定？

Answer 1

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

.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.

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

Answer 2

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

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