本项目遵循以下代码规范以确保代码质量和一致性。
语言风格
- 中文:当前请求路径未指定语言风格,故以下内容为中文。
- English:若请求路径为
/en/project_documentation/coding_standards
,以下内容为英文。
规范内容
1. 命名规范
- 变量和函数:使用驼峰命名法(camelCase)。
- 常量:使用全大写字母和下划线命名(CONSTANT_NAME)。
2. 注释规范
- 代码注释:对复杂的逻辑和算法进行注释。
- 文档注释:使用JSDoc或相应语言的注释规范。
3. 格式规范
- 缩进:使用4个空格缩进。
- 换行:每行代码不超过80个字符。
4. 代码风格
- 避免重复:尽可能复用代码。
- 模块化:将代码分解为可重用的模块。
扩展阅读
更多详细规范,请参阅本项目文档.
图片示例
(center)
(center)