Skip to content

leobert-lan/ReportPrinter

Repository files navigation

ReportPrinter

依据代码中的注解,编译时生成:

  • 类图
  • Code Review 报告 等

这是一个框架,您可以使用项目内已经提供的 "注解+生成器" 或者 "自定义 注解+生成器"

框架部分能够:

  • 注解的发现
  • 将注解和被注解的信息给到自定义生成器模块处理
  • 收集自定义处理的结果,生成文档

本项目有两种使用方式:

  • 使用核心注解处理器+已经存在的功能扩展,例如UML类图扩展
  • 使用核心注解处理器+自定义功能扩展

可以快速获得的支持

项目内容说明

演示如何使用的相关内容说明

可直接获取的功能

核心注解处理器:

类图生成器,注解&注解处理器插件

review文档生成器,"TODO/BUG/DONE",注解&注解处理器插件

如何自定义功能扩展并使用:

参见此文档

License

MIT License Copyright (c) 2018 leobert-lan, see details
MIT License
 
Copyright (c) 2018 leobert-lan

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.