我们如何为Android应用程序创建自定义文档以描述应用程序流程？

Question

我们如何为Android应用程序创建自定义文档以描述应用程序流程？

androiddocumentation-generation

3

最近我的团队开始开发一个安卓应用程序，其中有超过200个屏幕。

在这种情况下，当我需要向其他开发人员解释代码或屏幕流程时，会遇到一个问题，这将会非常困难。因此，我不得不通过谷歌来寻找解决方案。

我不太了解安卓的解决方案。在javascript中，我使用jsDoc或swagger进行API文档记录，这提供了一个很好的方式。

但是在安卓上，我找不到编码文档和屏幕流程的解决方案。

我需要使用设计工具来解释安卓应用程序的屏幕流程和文档吗？

如果您需要更多细节或说明，请告诉我，我将相应更新问题或改进我的问题。

- Dipak

2个回答

0

首先进入文件->项目结构。在平台设置标题下，添加或选择Android平台。转到文档路径选项卡，并确保您的SDK文档文件夹的路径已添加 - 应为[SDK]\docs\reference，其中[SDK]是SDK安装的完整路径。如果未找到它，可以手动添加。完成后，在您想要显示帮助的项目上使用Ctrl+F1。

- Ajeett

是的，我很感激，但我不想使用Android内置功能。 - Dipak

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Alexander Hoffmann · Accepted Answer

无法创建自动化的屏幕/状态转换图。如果使用导航架构组件，则可以使用类似于苹果的故事板的导航编辑器。这很有帮助，但有时并不能涵盖所有内容。

在我们的项目中，我们依赖像overflow.io这样的工具来创建和维护屏幕流程图。我们使用来自Sketch或Adobe XD的设计文件或我们应用程序的截图。这是一个非常手动的过程。