nanhaoluo
a5419b0c6e
- style.css: 移除 4277 行多余空行 (16556 -> 12279 行) - style.css: 修复文件头注释格式 - style.css: 移除空规则集 - style.css: 统一缩进风格 - argontheme.js: 统一比较运算符为严格相等 (=== / !==) - argontheme.js: 移除多余空行 - 新增 .kiro/steering/code-style.md 代码规范文档
89 lines
1.8 KiB
Markdown
89 lines
1.8 KiB
Markdown
# Argon 主题代码规范
|
||
|
||
## CSS 规范
|
||
|
||
### 格式化规则
|
||
- 使用 Tab 缩进（1 Tab = 4 空格宽度）
|
||
- 每个属性独占一行
|
||
- 属性之间不要有空行
|
||
- 规则块之间保留一个空行
|
||
- 选择器与 `{` 之间有一个空格
|
||
- 属性值后的 `;` 前不要有空格
|
||
|
||
### 示例
|
||
```css
|
||
/* 正确 */
|
||
.selector {
|
||
property: value;
|
||
another-property: value;
|
||
}
|
||
|
||
.another-selector {
|
||
property: value;
|
||
}
|
||
|
||
/* 错误 - 属性之间有空行 */
|
||
.selector {
|
||
|
||
property: value;
|
||
|
||
another-property: value;
|
||
|
||
}
|
||
```
|
||
|
||
### 注释规范
|
||
- 区块注释使用 `/* ========== 区块名称 ========== */`
|
||
- 普通注释使用 `/* 注释内容 */`
|
||
- 多行注释每行以 ` * ` 开头
|
||
|
||
## JavaScript 规范
|
||
|
||
### 格式化规则
|
||
- 使用 Tab 缩进
|
||
- 字符串优先使用单引号 `'`
|
||
- 比较运算符使用严格相等 `===` 和 `!==`
|
||
- 语句末尾必须有分号 `;`
|
||
- 函数名与括号之间无空格
|
||
- 关键字后有空格（if, for, while, function 等）
|
||
|
||
### 变量声明
|
||
- 优先使用 `let` 和 `const`
|
||
- 避免使用 `var`（除非需要函数作用域）
|
||
|
||
### 注释规范
|
||
- 区块注释使用 `// ========== 区块名称 ==========`
|
||
- 函数注释使用 JSDoc 格式
|
||
- 单行注释使用 `//`
|
||
|
||
### 示例
|
||
```javascript
|
||
// ========== 功能模块名称 ==========
|
||
|
||
/**
|
||
* 函数说明
|
||
* @param {string} param - 参数说明
|
||
* @returns {boolean} 返回值说明
|
||
*/
|
||
function functionName(param) {
|
||
if (param === 'value') {
|
||
return true;
|
||
}
|
||
return false;
|
||
}
|
||
```
|
||
|
||
## PHP 规范
|
||
|
||
### 格式化规则
|
||
- 使用 Tab 缩进
|
||
- 字符串优先使用单引号
|
||
- 数组使用短语法 `[]`
|
||
- 类名使用 PascalCase
|
||
- 函数名使用 snake_case（遵循 WordPress 规范）
|
||
|
||
### WordPress 特定
|
||
- 使用 `esc_html()`, `esc_attr()` 等函数转义输出
|
||
- 使用 `wp_nonce_field()` 进行安全验证
|
||
- 遵循 WordPress Coding Standards
|