Как каждый просматривает “встроенные документы” .cpp файла?
У меня есть cpp файлы, наперченные комментариями, такими как следующее перед каждой функцией:
/**
* @brief Set the normal and expansion handshake timeouts.
*
* @param wm Array of wiimote_t structures.
* @param wiimotes Number of objects in the wm array.
* @param normal_timeout The timeout in milliseconds for a normal read.
* @param exp_timeout The timeout in millisecondsd to wait for an expansion handshake.
*/
Я предполагаю от формата, что должен быть некоторый способ экспортировать это в "дружественный" формат, возможно, HTML, который может затем быть считан способом, подобным Java API. Как я сделал бы это?
(Я нахожусь в Windows 7, под управлением Visual Studio MS 2010),
1 ответ
Определенный комментарий документа разрабатывает Вас, кавычка почти наверняка предназначается для обработки Doxygen. Это может генерировать достойную качественную документацию в нескольких выходных форматах из комментариев в источниках многих подобных языкам C. Существуют также плагины, доступные для обработки комментариев на некоторых неязыках C для включения в тот же документ.
Если Вам установили инструменты AT&T Graphviz и настраиваете Doxygen для использования их, то он может также нарисовать много полезных схем из исходного кода для включения в документацию.
Если проект использует Doxygen, то существует почти наверняка конфигурационный файл, который указывает что исходные файлы включать, что форматы генерировать, и опции, связанные с подробной обработкой. Это, вероятно, назвали бы doxyfile, или что-то подобное.
Общим выходным форматом является HTML для полного веб-сайта. Одним примером, доступным онлайн, является веб-сайт для самого Doxygen, который почти полностью сгенерирован путем выполнения Doxygen в его исходном дереве.