Russian Qt Forum

Qt => Вопросы новичков => Тема начата: rlens от Июль 03, 2012, 10:24



Название: Оформление исходников
Отправлено: rlens от Июль 03, 2012, 10:24
Уважаемые форумчане!
Подскажите пожалуйста для чего в исходниках Qt'шных примеров (fortuneserver.h, fortuneserver.cpp) вставляют строки:
...
//! [1]
...
//! [2]
...
Заранее спасибо.


Название: Re: Оформление исходников
Отправлено: mutineer от Июль 03, 2012, 10:24
Чтобы в текстовом описании на них ссылаться


Название: Re: Оформление исходников
Отправлено: rlens от Июль 03, 2012, 10:41
каким образом? и зачем? и почему перед цифрами стоят знаки //!
это же спец. символы для документирования Doxygena


Название: Re: Оформление исходников
Отправлено: Bepec от Июль 03, 2012, 10:46
rlens это примеры. К примерам прилагается описание. Описание генерируется текстовыми генераторами из комментариев. По поводу оформления комментариев достигнуты несколько соглашений. В данном случае они оформляются так и служат ссылками при генерации документации. Как бы вот так.

PS доксиген не единственный генератор. Их много.


Название: Re: Оформление исходников
Отправлено: DmitryM от Июль 03, 2012, 10:49
каким образом? и зачем? и почему перед цифрами стоят знаки //!
это же спец. символы для документирования Doxygena
Google забанил? qdoc3 (http://qt-project.org/wiki/Building_Qt_Documentation_Russian)


Название: Re: Оформление исходников
Отправлено: rlens от Июль 03, 2012, 10:51
тогда чем генерится документация для Qt'шных примеров?


Название: Re: Оформление исходников
Отправлено: Bepec от Июль 03, 2012, 10:53
Смотри выше *рукалицо*