JavaSE基础语法 - JavaDoc

JavaSE基础语法 - JavaDoc

记录自己的学习之路,2025年7月23日,周三,午,天气阴晴。JavaDoc学习。

JavaDoc是什么

JavaDoc是一种将注释生成HTML文档的技术,生成的HTML文档类似于Java的API,易读且清晰明了。

javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配
套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过
Javadoc就可以同时形成程序的开发文档了

文档注释关键词:

  • @author 作者名
  • @version 版本号
  • @since 指明需要最早使用的jdk版本
  • @param 参数名
  • @return 返回值情况
  • @throws 异常抛出情况

命令行生成Doc

-encoding UTF-8 -charset UTF-8
//解决GBK乱码问题,在中间添加编码设置

image-20250723173729594

posted @ 2025-07-23 17:39  点态  阅读(7)  评论(0)    收藏  举报