В моей команде у нас есть подход к конструкции по нашему коду C ++, который мы выражаем через наши комментарии Doxygen. Объявление, объясняя, каковы его параметры, его предварительные условия, его возвратные значения и пост -кондиционирования, чтобы абоненты точно знали, как должна вести себя функция без необходимости взглянуть на реализацию функции. < /p>
Мы Также хочу, чтобы комментарий доксигена был в верхней части определения каждой функции, потому что он позволяет писать или поддерживать функцию, чтобы знать, что должна делать реализация, чтобы они могли убедиться, что она делает правильную вещь.
Однако, поскольку один и тот же комментарий доксигена должен быть в двух местах, что поднимает вопрос о том, как обеспечить оба оставаться одинаковыми с течением времени. Есть ли инструмент или параметр доксигена, который можно использовать для проверки, что оба комментария одинаковы?
Подробнее здесь: https://stackoverflow.com/questions/794 ... ration-and
