Документирование кода в Xcode 8
Я видел, что руководство пользователя Apple HeaderDoc было помечено как "Документ в отставке" с этим примечанием:
Важный: этот документ может не представлять лучшие методы для текущей разработки. Ссылки на загрузки и другие ресурсы могут быть недействительными.
Этот документ последний раз обновлялся в мае. Итак... какие лучшие практики для документирования кода сейчас в Xcode 8 будут? Я не нахожу дополнительной информации по этому поводу.
1 ответ
Apple добавила новые функции в xCode 8, чтобы легко добавлять документацию в ваш код. Для этого просто наведите курсор на любой символ и выберите "Редактор"> "Структура"> "Добавить документацию" (Command-Option-/). Xcode сканирует выбранный вами символ и добавляет схему комментария к документу, включая именованные параметры и возвращаемые типы, если они существуют.
Более подробная информация на: http://ericasadun.com/2016/09/16/xcode-8-document-coding-enhancements/