QT специальные комментарии //: // [num] и т. Д. - PullRequest
4 голосов
/ 07 июля 2011

Что означают эти специальные комментарии в папке примеров qt?

Я знаю о "//:" это комментарий, который будет взят в программу перевода, если следующая строка содержит tr ("").

Код между // [], похоже, взят в сгенерированную HTML-документацию.

Есть ли документ с полным описанием специальных комментариев?

Ответы [ 2 ]

5 голосов
/ 07 июля 2011

Qt использует Специальные команды Doxygen в комментариях к коду. [Хорошо, если быть точным, Doxygen расширяет специальные команды комментариев Qt.] Специальные команды используются для управления генерацией документации, когда она запускается в коде. Тролли, которые поддерживают Qt, имеют свой собственный инструмент, который они используют для создания документов из кода. Doxygen был написан, чтобы дать нам простым смертным инструмент, который мы могли бы использовать.

Одна из вещей, которую вы можете сделать с Doxygen (и я предполагаю, что инструмент Qt), - включить пример кода в документацию. Зачастую требуется только часть кода, поэтому существуют некоторые специальные команды, которые можно использовать для управления отображаемой частью файла ( например, \line). Они полагаются на поиск маркеров в коде. ИМХО, // [xx] это просто те маркеры.

1 голос
/ 07 июля 2011

Это документ для комментариев перевода , без упоминания //[num], хотя ....

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...