Objective C @property комментарии
Я использую Doxygen для генерации документов для моей цели c код. До сих пор, хотя, я не был в состоянии найти любые инструкции для того, как правильно зарегистрировать свойства. Примеры, на которые я посмотрел, делают это каждый мыслимый путь. Некоторые люди документируют сами переменные, некоторые люди документируют @property объявления. Некоторое использование//, в то время как другие используют полный / ** */блоки.
Кто-либо может указать на меня на ссылку для лучших практик? Или возможно некоторая информация о будущей совместимости с Doxygen? Я хотел бы придерживаться шаблона, который, по крайней мере, будет легко адаптировать к Doxygen, как только они разрабатывают официальный шаблон.
2 ответа
Все, что я могу сказать, это то, что Core Plot framework аннотирует объявления свойств в реализации, используя формат, подобный
/** @property myProperty
* @brief Property is very useful
* Useful and there is a lot more to tell about this property **/
и, кажется, производит чистую документацию с помощью Doxygen. Из Политики документации Core Plot:
Требуется @property, поскольку doxygen не может найти имя свойства иначе.
Свойства доступа, такие как readonly, copy/retain/assign и nonatomic, добавляются добавляются автоматически и не должны встречаться в ручной части документации.
Здесь вы можете найти некоторую информацию о правилах кодирования для Objective-C: Руководство по стилю Google Objective-C
Но если хотите есть еще одна хорошая программа под названием HeaderDoc для создания документации под XCode. Вы можете проверить его стиль кодирования здесь: HeaderDoc Tags