Есть ли способ использовать документальные комментарии для тестовых примеров, определенных с помощью макросов Boost.Test? Могу ли я использовать комментарии в стиле Doxygen, будут ли они правильно разбираться?Документирование тестовых примеров Boost.Test
Ответ заключается в том, чтобы сделать ваши тестовые примеры настолько простыми, настолько очевидными и читаемыми, что любая документация, которую вы пишете, является излишней. См. Раздел под названием Test Case Maintenance and Design в моем rewrite of the Boost.Test docs.
Да, это само собой разумеется, но я думаю, что было бы неплохо иметь список всех тестовых примеров, прилагаемых к классу в тесте, поэтому документация показывает это и то, что тестируется. – Rene
Это добавляет дополнительную нагрузку на обслуживание, которая не оправдана ИМО. Это уже тот случай, когда фактические комментарии отклоняются от кода. Тенденция в разработке программного обеспечения заключалась в [выражении идей непосредственно в коде] (https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#Rp-direct) вместо того, чтобы полагаться на комментарии или дополнительные метаданные на код. – legalize
В соответствии с доксигенной [предварительной обработкой документации] (http://www.stack.nl/~dimitri/doxygen/preprocessing.html) должно быть возможно документировать эти тесты с нормальными комментариями в стиле доксигена, но вы, вероятно, придется потратить немного времени, играя с флагом 'predefined' в вашем файле конфигурации. См. Пример класса «IUnknown», примерно на полпути вниз на странице [this] (http://www.stack.nl/~dimitri/doxygen/preprocessing.html). – Chris