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 Studio Javadoc配置

1.搜索点击File—Settings—Plugins,搜索“Javadoc”,结果如下:点击“Search in repositories”,搜索结果如下:2.安装点击右上角“Install”,下载...

关闭java-8变态的java-doc检查

https://github.com/GPars/GPars/blob/master/build.gradle#L268 https://github.com/GPars/GPars/blob/mas...

Android Studio中利用JavaDoc生成项目API文档

1. 在Android Studio中的菜单项中点击Gener

Android Gradle配置自动生成JavaDoc

在Build.gradle中添加下面内容task javadoc(type: Javadoc) { source = android.sourceSets.main.java.srcDirs...

JavaDoc那些事儿

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

解决Android StudioJavaDoc文档乱码

Tools –> Generate JavaDoc –>打开对话框,如下 在”Other command line arguments”输入 -encoding utf-8 -charset u...

Android Studio Gradle 导出JavaDocJar提示编码GBK的字符无法映射解决办法

最近因为要把PreIOC放入jcenter中,百度找了很多方法,终于有点眉头了,但是却卡在了生成JavaDocJar,因为要放入jcenter中必须要上传生成的jar、sourcejar、和JavaD...

Android字体多样式和动画TextDrawable

 Android字体多样式和动画TextDrawable 在实际的Android开发中,很多时候,需要用TextView表现和展示view的内容和标题、标签之类。但是Android本身提供的T...

Android常用的Drawable和Bitmap之间的转化方法

bitmap和Drawable间的区别: Bitmap - 称作位图,一般位图的文件格式后缀为bmp,当然编码器也有很多如RGB565、RGB888。作为一种逐像素的显示对象执行效率高,但是缺点也很明...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:AdnroidStudio下javaDoc任务相关配置
举报原因:
原因补充:

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