Какой хороший способ сделать тип множественного числа при написании комментариев?

Question

При написании комментариев мне иногда приходится говорить о типе (классе, структуре и т. Д.) Во множественном числе при написании комментариев, например:

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

Проблема в том, что имя типа является единственным (а именно, Thing), но я хочу поговорить о них во множественном числе в комментариях.

Если я говорю Things, он предлагает читателю говорить о типе, называемом Things, но это не так. Если я скажу Thing's, это выглядит неловко, потому что это не грамматически правильно (это либо притяжательное, либо «вещь есть», а не множественное число). Я мог бы обсудить проблему и сказать 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.

Не уверен на 100% в варианте с кислородом, но должно быть что-то в этом роде.

И если вы не используете конкретную систему документации и, следовательно, не имеете специальных комментариев, я бы сделал что-то вроде:

Get a list of [Thing]s from somewhere.

Или вы можете использовать () или {}, в зависимости от предпочтения ...

Answer 2

Я бы использовал 's' в скобках.

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