我们如何为应用程序流程创建android应用程序自定义文档?

问题描述 投票:1回答:2

最近我的队友开始在一个Android应用程序上工作,该应用程序中有200多个屏幕。

在这种情况下,我面临一个问题,当我需要向其他开发人员解释代码或屏幕流程时,这将非常困难。所以我必须谷歌找到解决方案。

我不太了解android的解决方案。在javascript中,我使用jsDoc或swagger编写API文档,这提供了一种很好的方法。

但是在android中,我找不到编码文档和屏幕流程的解决方案。

我需要任何设计工具来解释Android应用程序的屏幕流程和文档吗?

让我知道,如果您需要更多详细信息或解释,我将相应地更新问题或完善我的问题。

android documentation-generation
2个回答
1
投票

无法创建自动屏幕/状态转换图。如果使用Navigation Architecture component,则可以使用类似于Apple故事板的导航编辑器。这很有用,但通常无法涵盖所有​​内容。

Android Studio navigation editor. Source: https://developer.android.com/guide/navigation/navigation-getting-started#nav-editor

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


0
投票

首先转到File -> Project Structure。在Platform Settings标题下,添加或选择一个Android平台。转到“文档路径”选项卡,并确保在其中添加了SDK文档文件夹的路径-它应为[SDK] \ docs \ reference,其中[SDK]是SDK安装的完整路径。如果找不到,则可以手动添加。完成后,在光标位于要显示帮助的项目上时使用Ctrl+F1

© www.soinside.com 2019 - 2024. All rights reserved.