Java如何让制作一个文档说明书

如何让制作一个文档说明书

- 第一步

• 写一个工具类
• 对这个工具类加上文档注释
• 用工具解析文档注释
• 格式：
  • javadoc -d 目录 -author -version xxx.java

---

- 制作文档说明书报错

• 找不到可以文档化的公共或受保护的类，权限不够
  • 给类加上 public 权限
• 编译出错：编码GBK不可映射的字符
  • 出现这样的错误，一般是因为代码中含有中文字符，注释中的中文字符也算。由于使用CMD运行java程序的时候，系统默认的编码格式是gbk。而包含中文字符的代码一般是UNICODE格式，所以直接运行含有中文字符的代码就很容易出现编码错误。可以通过终端修改编码格式来编译，或者用NotePad++修改文件编码格式来解决
  • javadoc -d 目录 -author -version -encoding UTF-8 xxxx.java