一、生成JavaDoc

为了方便查看功能解释，除了使用Swagger-ui以外，还需要知道非控制器（controller）类的功能，比如Service、Resource等。于是尝试了一下IDEA的生成JavaDoc功能（Tool->Generate JavaDoc...）。

 

 

二、生成失败报错

结果出现一堆的错误：

D:\Users\Administrator\IdeaProjects\plan-course\src\test\java\com\xchgx\cloud\sso8\webplancourse\dao\SemesterDaoTest.java:129: 错误: 编码GBK的不可映射字符
        System.out.println("鍒犻櫎琛?");
                                ^
D:\Users\Administrator\IdeaProjects\plan-course\src\test\java\com\xchgx\cloud\sso8\webplancourse\dao\SemesterDaoTest.java:131: 错误: 编码GBK的不可映射字符
        System.out.println("鍒涘缓琛?");
                                ^
D:\Users\Administrator\IdeaProjects\plan-course\src\main\java\com\xchgx\cloud\sso8\webplancourse\controller\CourseTimeController.java:8: 错误: 编码GBK的不可映射字符
@Api(value = "涓婅鏃堕棿鎺у埗鍣?",tags = {"涓婅鏃堕棿鎺у埗鍣?"})
                        ^
D:\Users\Administrator\IdeaProjects\plan-course\src\main\java\com\xchgx\cloud\sso8\webplancourse\controller\CourseTimeController.java:8: 错误: 编码GBK的不可映射字符
@Api(value = "涓婅鏃堕棿鎺у埗鍣?",tags = {"涓婅鏃堕棿鎺у埗鍣?"})
                                              ^
D:\Users\Administrator\IdeaProjects\plan-course\src\main\java\com\xchgx\cloud\sso8\webplancourse\po\CourseTime.java:8: 错误: 编码GBK的不可映射字符
 * 璇剧▼鏃堕棿琛?
          ^
D:\Users\Administrator\IdeaProjects\plan-course\src\main\java\com\xchgx\cloud\sso8\webplancourse\po\CourseTime.java:24: 错误: 编码GBK的不可映射字符
    private String holiday;//鑺傚亣鏃ュ悕绉?
                                    ^
D:\Users\Administrator\IdeaProjects\plan-course\src\main\java\com\xchgx\cloud\sso8\webplancourse\commandline\InitCommandLine.java:17: 错误: 编码GBK的不可映射字符
 * 绗竴娆¤繍琛屾椂鍒濆鍖?
                ^
D:\Users\Administrator\IdeaProjects\plan-course\src\main\java\com\xchgx\cloud\sso8\webplancourse\commandline\InitCommandLine.java:33: 错误: 编码GBK的不可映射字符
        log.info("绗竴娆¤繍琛屾椂锛屾鏌ュ悇绉嶈〃鍜屽叧绯?");
                                        ^
D:\Users\Administrator\IdeaProjects\plan-course\src\main\java\com\xchgx\cloud\sso8\webplancourse\commandline\InitCommandLine.java:39: 错误: 编码GBK的不可映射字符

三、解决方法

这里参考了另一位博主的博客（https://blog.csdn.net/qq_34054957/article/details/80892413），使用了附加的参数。

项目采用的是UTF-8编码，命令在Windows10环境下默认采用GBK编码，于是出现了正常的注释都出现乱码的现象。

在IDEA生成JavaDoc时，添加命令参数 -encoding utf-8 -charset utf-8

终于命令成功执行。

2021年1月23日