一、场景介绍
在项目开发过程中,特别是在为第二方团队提供功能支持时,需要编写接口文档
当然,编写接口文档的方式有很多,比如:
Word、在线API文档等等在这里采用
javadoc方式生成源码文档,方便快捷
二、生成方法
新建文档保存文件夹,如:
security-framework-doc采用
IDEA导入源码项目依次点击
IDEA菜单栏中的Tools-Generate JavaDOC...在弹出的对话框中填入相应的配置,如图:

P.S
如果只针对某一个文件配置
JavaDOC文档,可以选择单个文件即可配置列表和说明
zh_CN语种-encoding utf-8 -charset utf-8编码格式-tag date:a:"date"文档注释中没有的注解,采用这种方式添加
三、生成效果


版权声明:本文为Rambo_Yang原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。