/ *!*/ Что это значит? - PullRequest
       7

/ *!*/ Что это значит?

3 голосов
/ 10 октября 2011

Я только что нашел это объявление комментария в некотором примере проекта xcode:

/*!
@property masterVolume
@abstract Sets the master volume
*/
@property float masterVolume;

Комментарий, как обычно, зеленый, @property и @ abstract темно-зеленые. Если я уберу восклицательный знак, они будут одинакового зеленого цвета. Что, черт возьми, это значит?

Ответы [ 3 ]

4 голосов
/ 10 октября 2011

Чтобы сделать переход от headerdoc немного проще, appledoc (сбор за создание документации из кода, позволяющий сэкономить время в документации) также принимает многострочные комментарии в стиле headerdoc:

/*! Comment */

Источник

2 голосов
/ 10 октября 2011

Это стиль комментариев Qt. doxygen , Headerdoc и Appledoc рассматривается как комментарий к блоку. Автор был знаком с программированием на Qt и выбрал этот стиль комментариев. Вместо этого он мог выбрать /**, просто вопрос вкуса.

2 голосов
/ 10 октября 2011

В Objective-C комментарий ограничивается только / * * /, поэтому вы правы, восклицательный знак не является обязательным для формирования комментария.Однако в этом случае!можно сказать, что этот комментарий должен быть прочитан инструментом автоматической документации, таким как Doxygen или AutoDoc.То же самое касается символов @ там.@property говорит, что вы документируете свойство с именем masterVolume, а @abstract описывает, для чего это свойство.

...