微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

java库的gradle项目中javadocs和其他文档的标准目录是什么?

如何解决java库的gradle项目中javadocs和其他文档的标准目录是什么?

我已经开始开发一个 java (11) 库。我使用 Gradle (7.0) 进行构建,使用 git/GitHub 作为源存储库。

目前我的项目目录结构如下

    myproject
       gradle
       gradlew
       settings.gradle
       docs
       myproject-lib
          src
          build
             ...
            docs
               javadoc
       README.MD
       build.gradle
       ...

这(几乎)是使用 gradle init 生成的布局,但在顶层添加一个 docs 目录(我省略了一些目录、文件等)。

当我运行 gradlew javadoc 时,javadoc 文件$projectDir/build/docs/javadoc生成

我更喜欢将它们放在子目录 javadocs 下的顶级文档目录中 - 我的理由是所有文档都位于同一个易于查找的位置。这在 gradle 中很容易做到,但这是标准做法还是以后会引起问题?

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。