IntelliJ IDEA 生成项目源码文档

一、场景介绍

• 在项目开发过程中，特别是在为第二方团队提供功能支持时，需要编写接口文档

• 当然，编写接口文档的方式有很多，比如：Word 、在线 API 文档等等

• 在这里采用 javadoc 方式生成源码文档，方便快捷

二、生成方法

1. 新建文档保存文件夹，如：security-framework-doc

2. 采用 IDEA 导入源码项目

3. 依次点击 IDEA 菜单栏中的 Tools - Generate JavaDOC...

4. 在弹出的对话框中填入相应的配置，如图：
   

   P.S

   如果只针对某一个文件配置 JavaDOC 文档，可以选择单个文件即可

5. 配置列表和说明

   • zh_CN 语种

   • -encoding utf-8 -charset utf-8 编码格式

   • -tag date:a:"date" 文档注释中没有的注解，采用这种方式添加

三、生成效果