Иногда полезной формой документации может стать заголовочный файл.

Он компактно описывает переменные и методы экземпляров класса и может содержать комментарии с полезной информацией, которую больше нигде не найти. Отдельный заголовочный файл может содержать объявления нескольких интерфейсных и протокольных классов. Таким образом, он может быть прекрасным справочником.

Существует несколько способов просмотра заголовочных файлов в редакторе среды Xcode.

  • Если класс написан вами и вы редактируете файл реализации, выберите команду Navigate^Jump to Next Counterpart (<Command+Control+Up>).
  • Активизируйте меню Related Files на панели быстрых переходов (<Control+l>). Это меню позволяет переходить в любой заголовочный файл, импортируемый в текущий файл (и в любые файлы, которые импортируются в текущий файл), а также в заголовочные файлы суперклассов и подклассов текущего класса и т.д. Для того чтобы перейти в окно помощника, нажмите и удерживайте клавишу <Option>.
  • Выделите текст и выберите команду File^Open Quickly (<Command+Shift+0>), как описано в предыдущих разделах.
  • Нажмите клавишу <Command> и щелкните на символе, выберите команду Navigate^Jump to Definition или перейдите в справочное окно Quick Help, как описано в предыдущих разделах.
  • Используйте навигатор символов.

 

Все эти подходы требуют, чтобы окно проекта было открытым; для того чтобы операция выполнялась эффективно, команда File^Open Quickly требует, чтобы комплект SDK был активным, а другие команды работают с конкретным окном или словами в открытом проекте. Альтернатива, которая работает всегда, даже если ни один проект не открыт, заключается в

переходе в окно Terminal и использовании команды -h для открытия заголовочного файла в среде Xcode. Аргумент команды может быть частью имени заголовочного файла. Если возникает неоднозначность, то эта команда становится интерактивной; например, команда -h NSString может открыть как файл NSString. h, так и файл NSStringDrawing. h (или оба, или ни одного). Я бы хотел, чтобы эта команда была встроена в саму среду Xcode.


 

 

 

Добавить комментарий