代码拉取完成,页面将自动刷新
同步操作将从 dromara/Jpom 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
.
├── .gitee => gitee 配置
├── docs => 一键安装的命令脚本以及版本号文件
├── modules => java 后端目录(agent、server)
├── agent => 插件端代码
├── common => 这个项目的公共模块(插件端、服务端都依赖该模块)
├── server => 服务端代码
├── sub-plugin => 插件模块
├── script => 一些通用脚本
├── web-vue => 前端 vue 目录
├── .editorconfig => 前端(vue)代码格式配置
├── .editorconfig => 全局代码格式配置
├── .gitattributes => 文件编码格式配置
└── .... => 仓库一些默认配置
prettier
方式来格式化(需要安装插件)注:由于旧代码存在很多不规范问题,会逐步调整为新规范。在新写的代码都需要需要遵循上面说明
/**
* xxxxxxxx
* @author xxxx
* @since ${DATE}
*/
这里采用
@since
声明创建日期是因为Javadoc
规范里面并没有@date
标记所以采用@since
代替
推荐安装
Alibaba Java Coding Guidelines
(p3c
) 插件
https://www.e-learn.cn/topic/3680721
在新加功能、修复bug、优化功能在完成时候都需要在 CHANGELOG.md 记录
agent
、server
其中一个,就使用【agent】、【server】开头,如果都影响就不用@api
文档标记说明:如果没有 @api
文档标记,则定义的文档不会出现在生成后的 apiDoc 文档中。
说明:如果先定义 javaDoc 文档标记,再定义 apiDoc 的文档标记,则 javaDoc 的标记可能会包含在 apiDoc 的标记属性中,这并不是我们想要的结果。
正例:
/**
* @author hjk
* @api {method} path title
* @apiParam {Number} id Users unique ID.
*/
反例:
说明:参数 id 的说明应该是 Users unique ID. 如果这样定义则变成了 Users unique ID.@author hjk
/**
* @api {method} path title
* @apiParam {Number} id Users unique ID.
* @author hjk
*/
说明:使用 @apiDefine
定义通用的文档块,然后使用 @apiUse
来引用,增强文档块的复用性。
所有的文档块统一定义在 server
模块下的 io.jpom.ApiDoc
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。