开发编码规范
开发编码规范
开发编码规范
一、前端开发编码规范
【关键词】
ESLint/TS（代码校验）、Prettier（代码格式美化）、husky（代码提交校验）。
一、目录构建规范
目录构建规范用于确保项目目录结构的一致性和合理性。
- 保持一致性：确保整个项目的目录结构保持一致，避免出现不同模块或组件使用不同目录结构的情况。
- 层级结构合理：目录结构应尽可能扁平化，避免层级过深，以便于管理和维护。
- 命名规范：目录名称应使用小写字母和下划线，避免使用中文或特殊字符。
- 模块化：将功能相似的代码归为同一模块，并放置在同一目录下。
二、代码命名规范
代码命名规范用于确保代码的可读性和可维护性。
- 变量命名：使用有意义的名称，避免使用单个字母或无意义的缩写。变量名应小写字母和下划线组合，如：user_id。
- 函数命名：函数名应反映其功能，采用驼峰命名法。例如：getTotalCount。
- 类命名：类名应采用驼峰命名法，并使用大写字母开头，例如：UserModel。
- 文件命名：文件名应与其中的内容相关，采用小写字母和下划线组合，例如：user.js。
三、代码规范
代码规范用于确保代码的整洁和一致性。
- 缩进：使用 4 个空格进行缩进，避免使用制表符。
- 行长度：每行代码长度不超过 80 个字符。
- 分号：在每个语句的末尾使用分号，即使该语句只有一行。
- 行文风格：遵循统一的行文风格，避免出现中英文混合的情况。
- 空格：在运算符周围使用空格，例如 a = b + c。
- 注释：对复杂代码或逻辑进行注释，以便于他人理解。注释应简洁明了，避免过多的解释性注释。
- 函数长度：单个函数或方法长度不宜过长，应尽量将功能单一的函数或方法拆分成多个小函数或方法。
- 模块化：将功能相关的代码组织成模块或组件，提高代码的可重用性和可维护性。
- 错误处理：对可能出现的错误进行捕获和处理，避免程序崩溃或异常行为。
- 多态性：尽量利用函数重载和虚函数实现多态性，提高代码的复用率。
- 性能优化：在保证功能正确的前提下，尽可能提高代码的性能和响应速度。
- 兼容性：编写兼容性强的代码，确保在多种浏览器和设备上都能正常运行。
- 日志输出：在关键位置输出日志，便于排查问题和调试程序。
四、其他规范
- 图片格式：常见的图片格式有 GIF、PNG8、PNG24、JPEG、WEBP，根据图片格式的特性和场景需要选取适合的图片格式。
- 图片大小：
- PC 平台单张的图片的大小不应大于 200KB。
- 移动平台单张的图片的大小不应大于 100KB。
二、后端开发编码规范
TODO