<分区>
我开发了一个 Android 应用程序。
除了源文件中的注释,我还编写了路线图类型的文档,旨在帮助其他开发人员了解整个应用程序的结构。
我的问题: 在项目树中放置文档文件的位置,以便开发人员可以复制项目树,但不会打包到安装 APK 文件中?
<分区>
我开发了一个 Android 应用程序。
除了源文件中的注释,我还编写了路线图类型的文档,旨在帮助其他开发人员了解整个应用程序的结构。
我的问题: 在项目树中放置文档文件的位置,以便开发人员可以复制项目树,但不会打包到安装 APK 文件中?
最佳答案
通常的做法是包含包含高级文档的顶级 README
或 README.md
(markdown)。该文件放在项目根目录下。
许多项目托管提供商(例如 GitHub)在网站上查看项目时都会呈现此 README 文件。
要获得详细的文档,请继续使用内联 javadoc。
关于android - 在 Android 应用程序的项目树中的什么地方放置开发人员的文档?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/20593551/
相关文章:
android - 服务中的 stopSelf() 未调用 onDestroy
android - 在 Android 中使用 OnclickListener 时将值重置为默认值
C 文档 : help Doxygen recognize class structure
PHP 面向对象 : Unique method per argument type?
android - 滚动 ListView 时如何使单个标题粘在屏幕顶部?
javascript - 在 javascript 中记录传递给回调的参数的约定是什么?