コメントを書くとき、次のようなコメントを書くときに、タイプ (クラス、構造体など) について複数形で話す必要があることに気付くことがあります。
/*
* getThings
* Get a list of --> Things <-- from somewhere.
*/
Thing *getThings(void);
問題は、型名が単数形 (つまりThing) であるのに、コメントで複数形で話したいということです。
と言うとThings、 という型について話していることを読者に示唆しますThingsが、そうではありません。と言うとThing's、文法的に正しくないのでぎこちなく見えます (複数形ではなく、所有格または "Thing is" のいずれかです)。私は問題について話し、こう言うことができましたa list of Thing items
型の複数形を書く際に固執する良い規則は何ですか?
使用しているドキュメンテーション システムによっては、型の名前を特別な構文で囲み、その外側に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.
または、好みに応じて ( ) または { } を使用することもできます...
括弧内は「s」を使用します。
/* Get a list of Thing(s) from somewhere */