欢迎阅读 社区编码规范!为确保代码质量和团队协作效率,请遵循以下准则:
基本规范 ✅
- 代码可读性:优先使用清晰的变量名和注释(例如:
// 计算用户总数
) - 格式统一:遵循 社区代码结构指南 的缩进和空格规则
- 错误处理:所有异常需通过
try/catch
模块化处理,避免直接panic
命名规则 📚
类型 | 示例 | 规范说明 |
---|---|---|
变量名 | userName / 用户名称 |
中英文命名需保持一致 |
函数名 | calculateTotal() |
动词开头,驼峰命名法 |
常量名 | MAX_RETRY_TIMES |
全大写,下划线分隔 |
代码结构 🧱
- 模块划分:每个功能模块需独立封装(如
utils/
目录) - 注释规范:函数级注释需包含用途、参数和返回值(参考 社区文档)
- 测试要求:所有核心逻辑需配单元测试,测试覆盖率 ≥ 80%
代码风格 🎨
- 空格使用:运算符两侧保留空格(
a + b
而非a+b
) - 括号闭合:始终使用
{}
包裹代码块,避免单引号 - 函数参数:多参数时用逗号分隔,按重要性排序(如
function(param1, param2, param3)
)