Если ввод мета-комментариев, являющихся инструкциями для doxygen, является важной частью ваших усилий по написанию комментариев, вы делаете это неправильно.
Комментарий не должен включать в себя то, что может быть автоматически определеноинструмент, любой программист будет определять столько же (или больше) информации, например, из имен параметров, чем любой инструмент.
Другой способ взглянуть на это состоит в том, что doxygen уже делает отличную работу по представлению того, что может быть определено автоматически.Вам не нужно писать: «B :: B создает объект B», поскольку doxygen автоматически отсортирует его в разделе конструкторов документации.
Сфокусируйтесь на том, что неочевидно, и примитевремя подумать о том, что вы пишете.
Обычно многим функциям и переменным не требуется отдельный комментарий, поскольку либо имя носит достаточно описательный характер, либо их лучше объяснить в комментариях на уровне класса, описывающихкак взаимодействуют несколько членов.