7

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

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

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

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

在编写复数类型时要遵守什么好的约定？

4

2 回答 2

2

好吧，根据您使用的文档系统，您可以用特殊的语法包装类型的名称并将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.

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

如果您没有使用特定的文档系统，因此没有特别的评论，我会这样做：

Get a list of [Thing]s from somewhere.

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

于 2010-08-10T05:41:35.487 回答
1

我会在括号中使用“s”。

/* Get a list of Thing(s) from somewhere */
于 2010-08-10T05:45:24.510 回答