javadoc

说明

• doc注释是遵循一种特定形式的注释，用于生成javadoc。

• doc注释可以用来描述class. field, method。

• jdk提供 读取java文件并解析doc注释生成javadoc的功能。

• 具体使用参照本地项目Project JavaDemo的package grammarOnJDK1dot8.date20210316.javadocTest1

generate javadoc using idea

ui：top navigator - > tools - > Generate javadoc

config about Chinese comment

Generate javadoc -> Other Command Line arguments -> -encoding UTF-8

if you don't set, there are some errors like "unmappable character for encoding GBK".

References

Introduction to Javadoc