#c #visual-studio-code
#c #visual-studio-code
Вопрос:
Я видел этот комментарий к форматированию документа в библиотеке, которую я добавил в одно из своих рабочих пространств, и я вижу, что он использует что-то близкое к doxygen, и он отлично работает с VS code, я не устанавливал doxygen или любой другой плагин для генератора документов
/**********************************************************************/
/*!
@brief Apply the bracket's calibration curve to get a load in N from signal in mV
@param mV_reading The loadcell's input signal in mV
*/
/**********************************************************************/
float _getTorqueNmFromBracketCurve(float mV_reading);
Он работает очень хорошо и генерирует хороший документ при перетаскивании функции
Может кто-нибудь указать мне, что это за документ и где я могу найти его синтаксическую документацию / аргументы, чтобы научиться его использовать?
Спасибо!
Комментарии:
1. Я полагаю, что это функция быстрой информации официального расширения C / C , хотя документации на веб-сайте уже почти два года, и они, возможно, немного обновили эту функцию. Я не смог найти никаких официальных документов по синтаксису, но, как вы упомянули, похоже, он использует стандартный синтаксис doxygen.
Ответ №1:
Visual Studio и Visual Studio Code распознают форматирование комментариев Doxygen.
/** , /*! а также /// поддерживаются комментарии в стиле.
Существуют также расширения, которые могут генерировать комментарии doxygen.