、java 和 groovy 插件自带文档任务 ---- 在 Gradle 面板 中的 自定义 Gradle 插件的 Module 模块 下 , 有 documentation 任务分组 , 其中有 groovydoc 任务的输出目录 from javadoc.destinationDir, groovydoc.destinationDir } 由于上述任务需要用到 javadoc 和 groovydoc 任务的输出目录 , 因此需要依赖于 javadoc 和 groovydoc 任务 ; 在自定义 Gradle 任务的 构造函数中 , 添加 dependsOn: [javadoc, groovydoc] 参数 , 任务的输出目录 from javadoc.destinationDir, groovydoc.destinationDir } 三、生成文档 Jar 包 ---- 同步代码 , 同步完之后 , ] , 首先执行的是 groovydoc 任务 , 然后执行 javadoc 任务 , 最后执行 document2Jar 任务 ; 执行完毕后 , 在该模块的 build/libs 目录 下 , 生成了
2.1.1 Runtime Groovydoc Groovy从3.0.0版本开始,就支持在运行时保留文档注释(Groovydoc)。 默认情况下,这个功能是关闭的状态。 我们如果需要开启的话: 在JVM启动选项配置中,添加下面的内容 -Dgroovy.attach.runtime.groovydoc=true 运行时Groovydoc以/**@开始,以*/结束,例如: /**@ * Some class groovydoc for Foo */ class Foo { /**@ * Some method groovydoc for bar */ void bar() { } } assert Foo.class.groovydoc.content.contains('Some class groovydoc for Foo ') assert Foo.class.getMethod('bar', new Class[0]).groovydoc.content.contains('Some method groovydoc
/shanyshanb.com/" /* 多行注释的开始 多行注释的结束 */ println 1 /* 注释:一 */ + 2 /* 注释:二 */ 1.3 Groovydoc 注释 与多行注释类似,Groovydoc注释是多行注释,但以/**开头,以*/结尾。 Groovydoc第一条注释行之后的行可以选择以星号*开头。 这些注释与如下概念有关: 类型定义(类、接口、枚举、注解) 字段和属性定义 方法定义 如果不在上述概念处添加Groovydoc,编译器不会告警。但应该在这些结构之前加上注释。 @return 打招呼的内容 */ String greet(String otherPerson) { "你好, ${otherPerson}" } } Groovydoc
sourcesJar(type: Jar) { from 'src/main/groovy' exclude 'META-INF' classifier = 'sources' } groovydoc includePrivate = true source = 'src/main/groovy' } task groovydocJar(type: Jar, dependsOn: groovydoc ) { classifier = 'javadoc' from groovydoc.destinationDir } artifacts { archives groovydocJar
自定义文档打包任务 // 自定义 Jar 类型的 Gradle 任务 // 将文档打包到 jar 包中 task document2Jar(type: Jar, dependsOn: [javadoc, groovydoc 'plugin' // 指定分类器 , 与其它 jar 包进行区分 classifier 'doc' // 设置打包哪些文件 // 这里设置的是 javadoc 和 groovydoc 任务的输出目录 from javadoc.destinationDir, groovydoc.destinationDir } // 配置 工程工件 对应的 jar 包产出 配置 // 这里将
自定义文档打包任务 // 自定义 Jar 类型的 Gradle 任务 // 将文档打包到 jar 包中 task document2Jar(type: Jar, dependsOn: [javadoc, groovydoc 'plugin' // 指定分类器 , 与其它 jar 包进行区分 classifier 'doc' // 设置打包哪些文件 // 这里设置的是 javadoc 和 groovydoc 任务的输出目录 from javadoc.destinationDir, groovydoc.destinationDir } // 配置 工程工件 对应的 jar 包产出 配置 // 这里将
自定义文档打包任务 // 自定义 Jar 类型的 Gradle 任务 // 将文档打包到 jar 包中 task document2Jar(type: Jar, dependsOn: [javadoc, groovydoc 'plugin' // 指定分类器 , 与其它 jar 包进行区分 classifier 'doc' // 设置打包哪些文件 // 这里设置的是 javadoc 和 groovydoc 任务的输出目录 from javadoc.destinationDir, groovydoc.destinationDir } // 配置 工程工件 对应的 jar 包产出 配置 // 这里将
Documentation tasks ------------------- groovydoc - Generates Groovydoc API documentation for the main
/groovy-cli-commons-2.5.5.jar:lib/groovy-groovysh-2.5.5.jar:lib/groovy-console-2.5.5.jar:lib/groovy-groovydoc
如果你下载的是gradle-xx-all.zip的完整包,它会有以下内容: 二进制文件 用户手册(包括PDF和HTML两种版本) DSL参考指南 API手册(包括Javadoc和Groovydoc
GroovyDoc注释,和JavaDoc注释类似。 /** * Creates a greeting method for a certain person.