游戏行业前端部前端工程师前端开发规范手册.docxVIP

游戏行业前端部前端工程师前端开发规范手册

第1章基础规范

1.1代码风格

代码风格看似琐碎，实则关乎团队协作效率与代码可维护性。一套统一的风格能显著降低理解成本，尤其当项目规模扩展时，差异化的风格往往成为技术债务的主要来源。

关键原则：

-使用`camelCase`作为变量和函数命名规范（如`userProfile`），类名首字母大写（如`UserProfile`）。

-组件命名采用`kebab-case`（如`user-profile`），避免连字符与驼峰混用。

-保留行间距，建议每行80-120字符，过长需换行（如CSS样式）。

-逻辑块间空一行，相同类型操作（如条件语句）缩进层级保持一致（4个空格）。

场景案例：

假设某组件库由5人独立开发，若无风格约定，则`map`与`forEach`的混用、`const`与`let`的随意替换，将导致构建阶段出现30%以上的语法校验失败。

1.2代码注释

有效注释类型：

-文档式注释：JSDoc格式，用于API说明（如`/

获取用户头像URL

param{string}userId-用户标识

/`）。

-逻辑性注释：解释非直观的代码逻辑（如`//特殊：此处需绕过缓存机制`）。

-TODO注释：明确标注待办项，附截止日期（如`//TODO202