使用工具javadoc创建帮助文档

1.步骤

  • 对文档进行文档注释;
  • 使用javadoc工具生成说明文档。

2.注意

  • 若某类要生成帮助文档,则:该类必须是public或protect。
  • 使用javadoc生成的帮助文档出现的问题:

① 编码GBK的不可映射字符 (原因:有中文注释,解决:javadoc -encoding utf-8 ***.java)
② 生成的文档内容是空白的(set classpath=.)
③ 生成的文档出现乱码(javadoc -encoding uft-8
-charset ***.java)

使用工具javadoc创建帮助文档

  • 默认构造函数与类同修饰符(如上图均为public)
    使用工具javadoc创建帮助文档