v6ole
31 lines
1.6 KiB
Markdown
31 lines
1.6 KiB
Markdown
# 代码规范
|
||
|
||
## 触发条件
|
||
|
||
编写或审查 Python、前端代码前读取。代码接收输入、处理数据、鉴权、日志、调用外部服务或操作文件时，同时读取 `06-security-and-secrets.md`。
|
||
|
||
## 优先核验原文
|
||
|
||
- Python：`06-python-coding.md` 第 2 章。
|
||
- 前端：`07-frontend-coding.md` 中适用的 HTML/CSS/JavaScript/TypeScript 章节。
|
||
- 通用实现：`03-overall-rd-standard.md` 第 4.5 节；`12-security.md` 的通用及对应语言章节。
|
||
|
||
## 规范要求
|
||
|
||
- 按对应语言原文核验命名、注释、文档字符串、格式、导入和表达式规则。
|
||
- Python 重点核验包/模块与变量小写、类命名、文档字符串、注释、缩进、导入、字符串、空值比较和空白规则。
|
||
- 前端重点核验 HTML 文档/title/敏感注释，CSS 命名与声明，以及 JavaScript/TypeScript 的导入、变量、相等判断、流程控制和模块规则。
|
||
- 不得混用语言规范。本包未包含 Java、Go、C/C++、Android 编码分册；缺少对应原文时必须标记为语言专项证据缺口。
|
||
|
||
## 工程建议
|
||
|
||
在本地和 CI 中自动执行格式化、静态检查、类型检查和针对性单元测试；保持公开接口小而清晰，将副作用隔离在边界，并使用显式错误路径和已校验的数据契约。
|
||
|
||
## 审查证据
|
||
|
||
变更差异、格式化/静态检查/类型检查结果、单元测试结果、适用扫描结果，以及带原文章节的评审结论。
|
||
|
||
## 使用边界
|
||
|
||
仅当语言原文或安全原文明确规定时才可判定为强制；框架偏好和代码风格偏好应标为工程建议。
|