После некоторого исследования наилучшего способа документировать быстрый код. Я наткнулся на Jazzy и как просто было реализовать. Поэтому я следую разделу установки Jazzy Documentation. Я запустил
sudo gem install jazzy
Затем я перехожу к корню моего проекта в терминале и запускаю jazzy, который создает папку под названием "docs" с веб-сайтом, на котором отображается документация для 1 класса. У меня есть 87 классов, которые я вижу наглядно, чтобы на выходе терминала выполнялось jazzy.
Я прочитал Учебное пособие NSHipster о документировании кода, который также связывает вас с Jazzy Documentation, а также Ссылка на форматирование разметки. Я документировал некоторый код, который Xcode корректно отображает на боковой панели или правой кнопкой мыши по функции или классу. Поэтому я уверен, что мой синтаксис верен.
Я потратил некоторое время, чтобы сравнить этот 1 файл с другим файлом, который не отображается, и я не вижу ничего необычного в отношении формата.
Я запускаю:
- jazzy версия: 0.3.2
- Версия Xcode: 7.1
- Быстрая версия: 2.1
- OS X El Capitan Версия: 10.11
Мой общий вопрос: Почему не язвительно производя документацию для всех классов и как я могу исправить эту проблему?