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

Question

Недавно мои товарищи по команде начали работать над приложением android, которое имеет более 200 экранов в приложении.

В этом случае я сталкиваюсь с одной проблемой: когда мне нужно объяснить код или поток экрана другому разработчику, это будет слишком сложно. Поэтому я должен Google, чтобы найти решение.

Я не очень осведомлен о решении для android. В javascript я использовал jsDo c или swagger для документации API, которая предложила отличный способ.

Но в android я не смог найти решение для документации по кодированию и экранного потока.

Нужен ли какой-либо инструмент проектирования для объяснения последовательности экранов и документирования приложения android?

Дайте мне знать, если вам нужны дополнительные сведения или пояснения, я соответствующим образом обновлю вопрос или улучшу свой вопрос .

Answer 1

Нет способа создать автоматическую диаграмму перехода между экраном и состоянием. Если вы используете Компонент архитектуры навигации , вы можете использовать редактор навигации, который похож на раскадровки Apple. Это полезно, но зачастую это не все.

В наших проектах мы используем такие инструменты, как overflow.io создавать и поддерживать экранные диаграммы. Мы используем файлы дизайна из эскиза или Adobe XD или скриншоты из нашего приложения. Это очень ручной процесс.

Answer 2

Сначала Go до File -> Project Structure. Под заголовком Настройки платформы добавьте или выберите Android Платформа . Go перейдите на вкладку Пути документации и убедитесь, что туда добавлен путь к папке документации вашего SDK - это должно быть [SDK] \ docs \ reference , где [SDK] - полный путь к вашему SDK. установка. Если он не найден, вы можете добавить его вручную. После его завершения используйте Ctrl+F1, когда курсор находится на элементе, для которого вы хотите отобразить справку.