docs: 强化作者规范说明,明确必须使用 pangu
This commit is contained in:
parent
38eba2812a
commit
1939180830
|
|
@ -10,14 +10,18 @@ alwaysApply: true
|
|||
>
|
||||
> **重要声明**:本规范仅适用于 pangu-user-platform 项目,不受外部工程目录(如 `/Users/felix/hbxhWorkSpace/.cursorrules`)中其他规范的影响。当本规范与外部规范冲突时,以本规范为准。
|
||||
|
||||
## 作者规范
|
||||
## 作者规范(必须遵守)
|
||||
|
||||
**重要**:本项目所有文档、代码注释的作者统一使用 **pangu**
|
||||
> ⚠️ **强制要求**:本项目所有代码、文档、脚本的作者**必须**使用 **pangu**
|
||||
>
|
||||
> **不要使用**:湖北新华业务中台研发团队、个人姓名、英文名或其他任何名称
|
||||
|
||||
- 文档的作者/编写团队字段:`pangu`
|
||||
- 代码注释中的 @author 标签:`pangu`
|
||||
- SQL 脚本中的作者注释:`pangu`
|
||||
- 不使用个人姓名、英文名或其他名称
|
||||
| 位置 | 作者写法 |
|
||||
|------|----------|
|
||||
| Java @author | `@author pangu` |
|
||||
| SQL 注释 | `-- 作者:pangu` |
|
||||
| 文档署名 | `pangu` |
|
||||
| Shell 脚本 | `# 作者:pangu` |
|
||||
|
||||
示例:
|
||||
```java
|
||||
|
|
|
|||
Loading…
Reference in New Issue