crossplatform.ru

Здравствуйте, гость ( Вход | Регистрация )

 
Ответить в данную темуНачать новую тему
> Теги комментирования в Qt, Поиск документации, взаимодействие с Assistant
legat
  опции профиля:
сообщение 8.8.2010, 16:22
Сообщение #1


Студент
*

Группа: Новичок
Сообщений: 10
Регистрация: 8.8.2010
Пользователь №: 1940

Спасибо сказали: 0 раз(а)




Репутация:   0  


Простите если данная тема уже поднималась, просто никак не найду ответа.
Просматривал исходники Qt и обнаружил следующую систему комментирования, например:
/** \class VolumeSlider volumeslider.h Phonon/VolumeSlider
* \short Widget providing a slider to control the volume of an AudioOutput.
*
* \ingroup PhononWidgets
* \author Matthias Kretz <kretz@kde.org>
*/
class PHONON_EXPORT VolumeSlider...
Следовательно имеется чёткий набор тегов для комментирования, таких как \class, \brief и т.п.
1) Подскажите, где можно найти исчерпывающую документацию по данным тегам (записывающихся через обратный слэш)?
2) Как будто с помощь этих тегов и Assistant-а можно сделать документацию к своему коду. Как это сделать?

Заранее спасибо.
Перейти в начало страницы
 
Быстрая цитата+Цитировать сообщение
Litkevich Yuriy
  опции профиля:
сообщение 8.8.2010, 17:56
Сообщение #2


разработчик РЭА
*******

Группа: Сомодератор
Сообщений: 9669
Регистрация: 9.1.2008
Из: Тюмень
Пользователь №: 64

Спасибо сказали: 807 раз(а)




Репутация:   94  


legat, троли не рекомендуют использовать их qdoc3, т.к. он может изменятся от выпуска к выпуску и он не имеет официальной документации.

Наиболее распространённая система документирования для Си++ - Doxygen. (его, к стати, разработал автор qdoc после его ухода из Trolltech.

тут вот что-то на русском: http://www.doxygenorg.ru/
Перейти в начало страницы
 
Быстрая цитата+Цитировать сообщение

Быстрый ответОтветить в данную темуНачать новую тему
Теги
Нет тегов для показа


1 чел. читают эту тему (гостей: 1, скрытых пользователей: 0)
Пользователей: 0




RSS Текстовая версия Сейчас: 16.5.2022, 10:44