JavaDoc Github

About

该项目主要是通过 JavaDoc API 读取 class 中的信息 (注释、方法名、参数、返回值等), 方便大家通过了解 JavaDoc API 并能够实现节省时间、提高效率的工具

编写该项目主要是提高效率, 方便自己工具类项目生成 API 以及检测代码规范、中英字符间距、@param、@return 等容易遗漏且复杂耗时的操作

• 生成效果示范 DevUtils - API

JavaDoc

使用演示类 JavaDocMain 介绍了使用方法, 以及可获取信息

项目类结构 - 包目录

• Class 信息读取类（JavaDocReader）：核心类, Class 信息都通过该类 API 读取

代码排版

代码、注释间距规范检测通过第三方类 (pangu.java) 进行检测

• Github - vinta/pangu.java

• 中文文案排版指北 - 简书

DevUtils API 生成

项目类结构 - 包目录

• DevUtils API 生成实现代码（API Generate）：该包下的类, 有各自的作用主要用于生成 DevUtils API 文档

• DevUtils 代码规范检测（Code Checker）：该包下的类, 主要检测是否缺少注释、@param、@return、重复换行等代码, 并且支持注释间距检测覆盖操作

• API 生成配置信息（API Config）：配置生成 API 相关信息, 以及忽略指定类、方法的配置等

• API README 生成执行方法（API README）：通过执行该类 Main 方法, 按 API Config 信息生成 API 文档