javadoc相关问题

欢迎和大家交流技术相关问题: 邮箱: jiangxinnju@163.com 博客园地址: http://www.cnblogs.com/jiangxinnju GitHub地址: https://github.com/jiangxincode 知乎地址: https://www.zhihu.com/people/jiangxinnju

  • src源代码生成html格式文档:http://www.cnblogs.com/shenliang123/archive/2012/04/23/2466483.html
  • 自己动手制作chm格式开源文档:http://www.cnblogs.com/shenliang123/archive/2012/04/23/2466441.html
  • Javadoc转换chm帮助文档的四种方法总结: http://lishunli.iteye.com/blog/1051688
  • 如何使用eclipse生成javadoc帮助文档?:http://jingyan.baidu.com/article/dca1fa6f4d3d7ff1a4405239.html

maven下载源码和javadoc

当在IDE中使用Maven时如果想要看引用的jar包中类的源码和javadoc需要通过maven命令下载这些源码,然后再进行引入,通过mvn命令能够容易的达到这个目的:

    mvn dependency:sources
    mvn dependency:resolve -Dclassifier=javadoc

命令使用方法:首先进入到相应的pom.xml目录中,然后执行以上命令。第一个命令尝试下载在pom.xml中依赖的文件的源代码。第二个命令尝试下载对应的javadocs。但是有可能一些文件没有源代码或者javadocs。也可以通过配置文件添加,打开maven配置文件 setting.xml文件(.../.m2/settings.xml) 增加如下配置:

    <profiles>
    <profile>
        <id>downloadSources</id>
        <properties>
            <downloadSources>true</downloadSources>
            <downloadJavadocs>true</downloadJavadocs>
        </properties>
    </profile>
    </profiles>

    <activeProfiles>
      <activeProfile>downloadSources</activeProfile>
    </activeProfiles>

配置eclipse

Window > Preferences > Maven and checking the "Download Artifact Sources" and "Download Artifact JavaDoc" options

maven中如何生成javadoc

mvn javadoc:javadoc

javadoc注意点(原创)

javadoc生成文档时总是报java.lang.IllegalArgumentException错

JavamavenEXTSUNJDK .

javadoc生成文档时总是报java.lang.IllegalArgumentException错误,是classpath里面字符冲突引起的。我在classpath中包含了变量引用,如:%JAVA_HOME%\lib;解决方法是重新设置classpath或者删除classpath.要注意设置完成后重启下cmd或者editplus,重启后生效!

见官方参考文档 http://maven.apache.org/plugins/maven-javadoc-plugin/faq.html

javadoc生成时出错:编码GBK的不可映射字符

由于java源代码是用的UTF-8编码,Eclipse中默认编码是GB18030,因此,在生成javadoc的时候,需要手工指定一下编码和字符集。

解决方案是:主菜单–>Project–>Generate javadoc–>next>next–>Extra javadoc options下面的文本框中填入:

-encoding UTF-8 -charset UTF-8

一个例子

javadoc -d doc -subpackages edu.jiangxin -encoding utf-8 -charset utf-8 -exclude edu.jiangxin.utils:edu.jiangxin.service:edu.jiangxin.service.impl

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • javadoc相关问题

    src源代码生成html格式文档:http://www.cnblogs.com/shenliang123/archive/2012/04/23/2466483....

    用户1221057
  • 华为面试题——一道关于指针方面的编程题(C/C++)

        int A[nSize],其中隐藏着若干0,其余非0整数,写一个函数int Func(int* A, int nSize),使A把0移至后面,非0整数...

    用户1221057
  • 创建和使用Windows静态链接库

    首先明确这篇文章的目的,我希望大家能够通过这篇文章了解一下如何在实际工作中创建和使用Windows平台下的静态链接库。关于链接库的概念,希望大家参考维基百科”L...

    用户1221057
  • 浙大版《C语言程序设计(第3版)》题目集 习题10-2 递归求阶乘和

    本题要求实现一个计算非负整数阶乘的简单函数,并利用该函数求 1!+2!+3!+…+n! 的值。

    C you again 的博客
  • C# HTTP系列10 form表单的enctype属性

    在ASP.NET编程中经常遇到下面的代码片段,将人员信息以表单方式提交到后台程序并保存到服务器与数据库中。

    张传宁老师
  • Mysql 常用函数(13)- right 函数

    https://www.cnblogs.com/poloyy/p/12890763.html

    小菠萝测试笔记
  • 白话微服务60秒:服务网格

    TCP/IP让网络节点间的传输更加安全快捷,而服务网格是让服务间的信息交换更安全、更快速且更可靠。

    yuanyi928
  • Java常见问题

    自古深情留不住,总是套路得人心 最近经历了一次惨无人道的程序员笔试,真的是“笔”试,默默地来整理一下…… 以后遇到问题要多整理…… 常见套路: 当一个变量被赋值...

    二十三年蝉
  • SpringBoot是如何动起来的

    对应的就是 META-INF/spring.factories 文件中的 org.springframework.boot.SpringApplicationR...

    yunlgonn
  • SpringBoot 是如何动起来的

    调用SpringApplication.java 中的 run 方法,目的是加载Spring Application,同时返回 ApplicationConte...

    一个优秀的废人

扫码关注云+社区

领取腾讯云代金券