软件开发行业前端工程师工程师前端开发规范手册.docxVIP

软件开发行业前端工程师工程师前端开发规范手册

第1章基础规范

1.1代码命名规范

命名是代码的身份证。混乱的命名会像迷宫一样让维护者迷失。什么是好的命名？

它应当像字典一样精确，像诗一样简洁。避免使用无意义的缩写（除非团队有统一约定，如`api`或`dom`），拒绝`a`、`temp`这类幽灵变量。

分级标准

第一级：核心原则

-类名：使用`PascalCase`（如`UserInfoPanel`），体现组合性，避免超过4个单词的冗长

-变量名：`camelCase`（如`dataSourceCount`），必须反映数据语义

-函数名：动词开头（如`fetchUserDetails`），区分动作与状态

第二级：场景适配

-ReactHooks：`useFetchData`而不是`useGet`

-CSS类名：`btn-primary`而不是`.btnP`

-全局变量：`constAPI_KEY=xxxx;`而非`key`

第三级：禁忌清单

-保留字（如`class`、`enum`）

-误导性命名（如`tempData`但实际长期使用）

-代码注释中的命名（命名即注释，如`mapList`而非`listToMap`)

经验数据佐证：

GitHu