AdnroidStudio下javaDoc任务相关配置

原创 2016年05月30日 16:41:56

  这两天用AndroidStudio打包工程,中间涉及到task javaDoc,记录下对这方面的相关配置:

  1.如果工程中涉及到中文的话,在执行javaDoc任务时可能会报中文编码问题,这个问题在之前AndroidStudio上传jcenter及各种实现方式的比较中提到过,两种解决方案,另外也可以尝试配置全局的编码格式,具体步骤:找到工程根目录下build.gradle,在allprojects中添加相关配置,就像这样:

allprojects {
    repositories {
        jcenter()
    }
    tasks.withType(org.gradle.api.tasks.compile.JavaCompile){
        options.encoding="UTF-8"
        options.compilerArgs << "-Xlint:unchecked"
    }
}
这里主要就看tasks.withType(ort.gradle.api.tasks.compile.JavaCompil)这一段代码就行了,下面那个options.compilerArgs,这是用来配置在生成javaDoc文档时,lint不进行检查,这是针对lint检查最简单粗暴的方法,因为有时候可能会直接拷贝别人的源码,这样如果人家的源码中在执行javaDoc时出现问题就不好调了,而且去弄人家的东西也比较麻烦,注意,这种方式,不仅第三方源码不检查了,就连自己的代码也不会检查了,这是全局的,当然还有另外一种处理项目中第三方源码的方法

  2.去除javaDoc对第三方源码的编译,这种方式就可以有效避免因为第三方源码带来的lint检查问题,具体操作:task javaDoc中添加exclude项进行配置,点进去看这个exclude方法就会发现这是支持字符串数组的方法:

    /**
     * {@inheritDoc}
     */
    public SourceTask exclude(String... excludes) {
        patternSet.exclude(excludes);
        return this;
    }
配置exclude的代码如下:
task javadoc(type: Javadoc) {
    source = android.sourceSets.main.java.srcDirs
    exclude "第三方源码的目录","第三方源码的目录","第三方源码的目录"
    classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
}
直接这样就可以了,注意这里配置的目录中间应该以"/"分开,包名可能是:com.example.project.openresource,那么第一个引号中就应该填入"com/example/project/openresource"即可。

Android Gradle配置自动生成JavaDoc

在Build.gradle中添加下面内容task javadoc(type: Javadoc) { source = android.sourceSets.main.java.srcDirs...
  • cooljean
  • cooljean
  • 2015年08月31日 15:34
  • 2558

gradle 上传repo with sources & javadoc

task sourcesJar(type: Jar, dependsOn: classes) { classifier = 'sources' from sourceSets.main.allSour...
  • yimzncy
  • yimzncy
  • 2015年11月23日 16:09
  • 638

gradle总报javaDoc生成错误

gradle总报 java文件编码错误。经常报javaDoc错误 例如: FAILURE: Build failed with an exception. * What went wrong: ...
  • wulong710
  • wulong710
  • 2016年12月29日 17:21
  • 1844

JavaDoc那些事儿

让程序员写一千行代码容易,要让他写一千字的文档就难了。 如果在代码中按照约定写一些注释,代码完成时相对应的文档就会自动生成就好了。 JavaDoc就是这么一个工具(在JDK/bin下可以找到),它...
  • lincyang
  • lincyang
  • 2013年02月02日 22:21
  • 4527

Android Studio javadoc 乱码问题

在把自己的 lib 库上传到jcenter上的时候,需要 javadoc ,一开始javadoc 编译不过先,后来还乱码,现在记录下来task sourcesJar(type: Jar) { ...
  • wxy318
  • wxy318
  • 2016年07月11日 10:13
  • 361

手把手教你使用 idea 生成漂亮的 javadoc 文档

1、打开 idea,点击 Tools-> Generate JavaDoc…这样会打开生成 javadoc 文档的配置页面。2、进行配置:标注的是重要的部分,从上往下分别是配置 javadoc 的范围...
  • deniro_li
  • deniro_li
  • 2017年05月12日 09:58
  • 750

实现javadoc自定义输出——doclet

doclet可以代替javadoc的输出,借由javadoc可以获取源码几乎所有的信息,类名、类变量、类方法、方法参数、注解、javadoc注释等都可以获取到,然后根据自己的需要把关心的信息输出成自定...
  • baiihcy
  • baiihcy
  • 2016年12月24日 17:40
  • 405

AdnroidStudio下javaDoc任务相关配置

这两天用AndroidStudio打包工程,中间涉及到task javaDoc,记录下对这方面的相关配置:   1.如果工程中涉及到中文的话,在执行javaDoc任务时可能会报中文编码问题,这个问题在...
  • IT_Phoenix
  • IT_Phoenix
  • 2016年05月30日 16:41
  • 498

javadoc是什么?

Javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Java...
  • anyhill
  • anyhill
  • 2007年07月27日 16:50
  • 1632

配置Eclipse中Javadoc工作

一、步骤图解 1.           打开Eclipse——>Windows——>Preferences           2. 在弹出的Preferences对话框中,Java——>Ins...
  • xiaogugood
  • xiaogugood
  • 2012年03月13日 13:22
  • 9371
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:AdnroidStudio下javaDoc任务相关配置
举报原因:
原因补充:

(最多只允许输入30个字)