Какие есть возможности добавить документацию на уровне модуля / папки?

Question

В проектах iOS / Xcode обычно используются строки документации с Markdown для документирования методов, свойств, протоколов и т. Д. В одном исходном файле.

Однако я не смог найти подходящего способа документирования «папки» файлов. Например. Я отсортировал функциональность моего приложения по разным папкам («Группы XCode») и хотел бы приложить некоторую документацию на этом уровне. Например, одна сетевая папка отвечает за сетевую аутентификацию, которая представлена ​​более чем одним исходным файлом.

Как этого добиться, чтобы мы всегда могли восстановить текущую документацию с помощью такого инструмента, как Jazzy?

Answer 1

Jazzy не документирует файлы на основе папки.Он создает Apple-подобную документацию, в которой слева он именует файл в алфавитном порядке.

Единственное, что вам нужно сделать, чтобы сгенерировать документ, это правильно прокомментировать ваш код.Jazzy анализирует ваш комментарий и создает для него документ.

Jazzy можно установить с помощью этой команды в терминале

[sudo] gem install jazzy

Необходимо указать минимальный спецификатор доступа для jazzy

jazzy --min-acl internal

здесь internal - спецификатор доступа, вы можете предоставить private , если вы хотите включить личные файлы для документации.

Команда jazzy компилирует ваш код, а затем создает документ для него.Убедитесь, что ваш код компилируется перед созданием документа.

Пожалуйста, обратитесь к этому документу: - https://medium.com/@_kenny/framework-friday-jazzy-c214fb9a5890