Awesome Open Source
Awesome Open Source

JavaDoc

Profile License Version

🍧 该项目通过 JavaDoc API 读取 class 中的信息 (注释、方法名、参数、返回值等)

Android 规范 Java 规范 Git 规范

作用

方便大家通过了解 JavaDoc API 并能够实现节省时间、提高效率的工具。

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

核心实现

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

项目类结构 - 包目录

  • Class 信息读取类(JavaDocReader):核心类,Class 信息都通过该类 API 读取

代码排版

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

DevUtils API 生成

项目类结构 - 包目录

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

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

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

API 生成实现类 ( 按 API Config 信息生成 API 文档 )

生成效果

License

Copyright 2022 afkT

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Java (411,578
Github (45,411
Code (18,110
Readme (9,026
Javadoc (1,797
Devutils (6