Documentation
README
JeecgBoot 开发规范
在 JeecgBoot 项目中编写或修改代码时,必须遵循以下规范。本 skill 是强制性的——任何代码变更都必须符合这些标准。
一、必做事项(每次代码修改必须完成,缺一不可)
1. 代码修改痕迹注释(内联注释)
所有新增或修改的代码块必须用 update-begin / update-end 注释包裹。
//update-begin---author:作者名 ---date:YYYYMMDD for:【bug号/需求号】修改说明-----------
// 新增或修改的代码
//update-end---author:作者名 ---date:YYYYMMDD for:【bug号/需求号】修改说明-----------
规则:
author填实际修改人,date格式YYYYMMDD(无横线),for填 bug号/需求号 + 简要说明- 新增方法:
update-begin放在方法声明前,update-end放在方法结束}后 - 修改已有方法中的代码:只包裹被修改的代码段,不包裹整个方法
- 用户未提供 bug 号时,必须主动询问
⚠️ 不需要加痕迹注释的改动(只要求逻辑变更才包裹):
以下纯机械性、轻量级或与业务逻辑无关的改动 不要 加 update-begin/end 注释,否则徒增 diff 噪音、破坏代码整洁:
This is the opening of the README. Read the full README on GitHub.