Синтаксис комментариев документации XCode

Мне было интересно, если кто-то может объяснить, что / если есть какая-то разница между синтаксисом следующих двух комментариев в XCode.

/**
 * comments
 */

/*!
 * comments
 */

Кажется, что оба позволяют Xcode отображать ваши комментарии как документацию, но я не уверен, есть ли разница между ними.

Источник

2 ответа

Решение

Они функционально эквивалентны. /*! является открывателем стиля HeaderDoc и /** является открывателем стиля JavaDoc, обычно используемым Doxygen. Xcode 5 поддерживает форматы HeaderDoc и Doxygen/JavaDoc.

Источник

Оба эквивалентны по функциональности.

Отличия:

/**

  1. Стиль Doxygen
  2. Если вы используете headerdoc2html команда, /** основанные комментарии не будут присутствовать в файле документации, они будут пропущены (см. HeaderDoc, не генерирующий документацию HTML)

/ *!

  1. Стиль HeaderDoc
  2. Если вы используете headerdoc2html командовать /*! комментарии будут отображаться в файле документации в формате HTML, в отличие от /**
Источник
Другие вопросы по тегам