41 lines
2.3 KiB
Markdown
41 lines
2.3 KiB
Markdown
---
|
||
name: no-game-references
|
||
description: '编写或修改 C# 代码时加载此规则:确保命名、注释、Tooltip、Header 中不出现其他游戏的专有名称(如 HK / Hollow Knight / Silksong / Ori 等)或明确引用。触发场景:新建 .cs 文件、修改已有 .cs 文件、Code Review .cs 代码是否合规。'
|
||
---
|
||
|
||
# 代码命名与注释:禁止引用其他游戏
|
||
|
||
## 规则
|
||
|
||
在编写或修改任何 C# 代码时,**命名(变量名、方法名、类名)、注释(`//`、`///`)、`[Tooltip]`、`[Header]` 字段标签** 中均不得出现以下内容:
|
||
|
||
- 其他游戏的**专有名称**(如:空洞骑士、丝之歌、奥日,以及对应英文 Hollow Knight、HK、Silksong、Ori 等)
|
||
- 其他游戏中的**专属机制/道具名称**(如:Mothwing Cloak、Monarch Wings、暗影披风 等)
|
||
- "对齐 XX 游戏"、"仿 XX 风格"、"参考 XX"、"类比 XX"等措辞中明确出现游戏名
|
||
|
||
## 正确做法:描述功能特点
|
||
|
||
若某设计参考了其他游戏的机制,**只描述该机制的功能特点**,不写出游戏名。
|
||
|
||
| ❌ 禁止 | ✅ 替换为 |
|
||
|---|---|
|
||
| `// 对齐空洞骑士手感` | `// 下落比上升更快,手感紧实` |
|
||
| `[Header("跳跃(对齐空洞骑士手感)")]` | `[Header("跳跃")]` |
|
||
| `[Tooltip("HK ~0.12s")]` | `[Tooltip("推荐 0.12s")]` |
|
||
| `// 类比 HK Monarch Wings,随时可二段跳` | `// 上升阶段即可触发二段跳` |
|
||
| `// 仿丝之歌风格 Lookahead` | `// 速度自适应 Lookahead:速度越快,预测距离越大` |
|
||
| `/// 模拟空洞骑士的标志性相机手感` | `/// 实现下落快、起跳缓的非对称相机追随手感` |
|
||
| `// 对齐 HK:碰到实体墙不会压墙卡住` | `// 碰到实体墙立即中止,避免压墙卡住` |
|
||
| `private void ApplyHKComposerDefaults(...)` | `private void ApplyComposerDefaults(...)` |
|
||
| `[Tooltip("对齐空洞骑士 = 1 格血")]` | `[Tooltip("建议设为 1,确保任意触碰即扣一格血量")]` |
|
||
|
||
## 允许保留的通用术语
|
||
|
||
以下术语为业界通用设计词汇,**不视为游戏专名**,可正常使用:
|
||
|
||
- `Pogo` / `pogo`(踩踏弹跳,通用机制术语)
|
||
- `Charm`(可收集护符,本项目自有道具类型)
|
||
- `platformer`、`横版平台游戏`(泛指游戏类型)
|
||
- `Metroidvania`(泛指游戏类型)
|
||
- `手感`、`风格`(描述本项目自身功能的通用词)
|