my-coding-style
Installation
SKILL.md
编程规范
代码组织
- 单一职责:每个源文件应具有清晰、聚焦的作用域/目的
- 拆分大文件:当文件过大或处理过多关注点时应拆分
- 常量抽取:将常量移动到专用的
constants.js文件 - 环境变量统一:编程时若涉及到环境变量部分的代码,必须统一从前后端各自的
.env.*中读取 - UTF-8 编码:使用
UTF-8编码,若遇到携带BOM标记的文件,则必须移除BOM以避免编码出现问题,如果文件中出现乱码,需要及时检测并修复编码问题
JavaScript
- 使用 ES6+ 特性:优先采用现代 JavaScript 语法与特性
- JSDoc 规范:严格遵守 JSDoc 注释规范,记录函数参数、返回值与复杂逻辑