首页  思维导图  详情

【前端】开发规范大全

2023-07-13 09:25:16   1  举报





AI智能生成

超全前端开发规范

前端

读书笔记

工作流程

学习笔记

工作总结

作者其他创作

大纲/内容

开发基本规范

一、命名规范

1.文件名

1.1使用有意义的文件名

1.2文件名使用小写字母，单词之间使用下划线连接

2.变量名

2.1使用有意义的变量名

2.2变量名使用小写字母，单词之间使用下划线连接

3.函数名

3.1使用有意义的函数名

3.2函数名使用小写字母，单词之间使用下划线连接

4.类名

4.1使用有意义的类名

4.2类名使用驼峰命名法

二、代码规范

1.缩进

1.1使用四个空格进行缩进

2.换行

2.1每行代码不超过80个字符

2.2运算符放在行末，换行时运算符在上一行末尾

3.注释

3.1代码中添加必要的注释

3.2注释应该清晰明了，表达准确

三、安全规范

1.密码安全

1.1密码应该加密存储

1.2密码应该定期更改

2.输入验证

2.1对用户输入进行验证

2.2避免使用动态SQL语句

3.权限控制

3.1对用户权限进行控制

3.2限制用户访问敏感数据

四、团队规范

1.代码审查

1.1定期进行代码审查

1.2代码审查应该注重代码质量和安全性

2.版本控制

2.1使用版本控制工具管理代码

2.2定期备份代码

3.团队协作

3.1团队成员之间应该相互协作

3.2遵守团队规范，保持代码风格的一致性

前端代码编程规范

命名规范

通用规则

使用有意义的名称

使用驼峰命名法

避免使用缩写

避免使用数字作为开头

HTML/CSS规则

使用有意义的id和class名称

使用短横线分隔符

使用小写字母

JavaScript规则

使用有意义的变量名和函数名

使用常量时使用全部大写字母

使用驼峰命名法

代码格式规范

通用规则

使用4个空格代替制表符

每行代码不超过80个字符

使用空格分隔符

HTML/CSS规则

使用缩进

使用空行分隔代码块

JavaScript规则

使用大括号包裹代码块

每个变量和函数之间使用空行分隔

注释规范

通用规则

使用有意义的注释

避免使用无用的注释

避免使用过多的注释

HTML/CSS规则

使用注释分隔代码块

JavaScript规则

使用注释解释复杂的代码逻辑

使用注释解释函数的参数和返回值

其他规范

通用规则

避免使用全局变量

避免使用内联样式和脚本

HTML/CSS规则

使用外部样式表和脚本文件

JavaScript规则

使用模块化开发

避免使用eval函数

使用严格模式

使用const和let代替var

使用箭头函数代替匿名函数

使用模板字符串代替字符串拼接

NodeJS编程规范

一、命名规范

1.变量、函数、参数、属性名：小驼峰式命名法

2.类、构造函数：大驼峰式命名法

3.常量：全大写，单词间用下划线分隔

二、代码风格

1.缩进：使用2个空格进行缩进

2.行末不留空格

3.使用单引号代替双引号

4.每行末尾不使用分号

5.每个代码块使用花括号包裹

6.使用严格模式"usestrict"

三、模块规范

1.使用CommonJS规范

2.模块文件名使用小写字母，单词间用下划线连接

3.模块导出使用module.exports

4.模块导入使用require

四、注释规范

1.单行注释使用//，注释内容与//之间保留一个空格

2.多行注释使用/**/，注释内容与/*之间保留一个空格

3.函数注释使用JSDoc规范

五、错误处理

1.不要忽略错误，应该使用try-catch捕获错误

2.错误信息应该清晰明了，包含错误类型、错误原因、错误位置等信息

六、其他规范

1.使用ES6语法

2.避免使用全局变量

3.尽量使用const声明变量

4.尽量使用箭头函数

5.不要使用eval函数

6.不要使用with语句以上是NodeJS编程规范的相关资料。

TypeScript编程规范

命名规范

变量名：小驼峰式命名，如：firstName

常量名：大写字母和下划线命名，如：MAX_LENGTH

函数名：小驼峰式命名，如：getFirstName

类名：大驼峰式命名，如：Person

接口名：大驼峰式命名，如：IPerson

枚举名：大驼峰式命名，如：Gender

类型规范

基本类型：使用基本类型而非其包装对象，如：number而非Number

any类型：尽量避免使用any类型

void类型：只用于函数返回值类型

never类型：表示永不存在的值的类型，如：抛出异常或无限循环

代码风格

缩进：使用2个空格缩进

空格：操作符两侧加空格，如：a+b

分号：每条语句结束加分号

换行：每个语句结束后换行

注释：解释代码的作用，而非代码本身

引号：使用单引号

函数规范

函数返回值：尽量避免函数返回null或undefined

函数参数：尽量避免使用可选参数

函数重载：尽量避免函数重载

类规范

类成员顺序：先字段，后方法，构造函数放在最后

类成员修饰符：尽量避免使用public关键字

类成员命名：私有成员用下划线开头

模块规范

使用ES6模块语法

模块文件名：使用小写字母和中划线命名，如：person-info.ts

模块导出：使用export关键字

模块导入：使用import关键字

其他规范

使用const代替let和var

使用箭头函数代替匿名函数

使用模板字符串代替字符串连接

使用解构赋值

使用类型断言代替类型转换

接口（API）设计规范

基本原则

1.简洁易懂

2.一致性

3.易于扩展

4.易于维护

请求和响应

1.请求

1.1.URL规范

1.2.请求方法

1.3.请求头

1.4.请求体

2.响应

2.1.状态码

2.2.响应头

2.3.响应体

参数

1.参数类型

1.1.查询参数

1.2.路径参数

1.3.请求体参数

2.参数命名

2.1.使用小写字母和下划线

2.2.不使用缩写

2.3.不使用保留字

错误处理

1.错误响应

1.1.状态码

1.2.错误信息

2.异常处理

2.1.抛出异常

2.2.捕获异常

安全

1.认证

1.1.基本认证

1.2.OAuth2认证

2.授权

2.1.角色授权

2.2.权限授权

版本控制

1.URL版本控制

2.头部版本控制

其他

1.文档

1.1.API文档

1.2.SDK文档

2.日志

2.1.记录请求和响应信息

2.2.记录错误信息

REST API 开发规范

接口设计

命名规范

使用小写字母和下划线

遵循RESTful风格

使用名词表示资源

使用HTTP动词表示操作

避免使用动词

使用复数形式表示资源

使用连字符表示复合词

参数设计

使用HTTP动词表示操作，不需要在URL中体现

使用HTTP状态码表示结果

使用JSON格式传递数据

使用HTTP头传递元数据

使用HTTP缓存控制

使用HTTPS协议

安全性

使用OAuth2.0进行认证和授权

使用HTTPS协议传输数据

对敏感数据进行加密

使用防火墙和IDS/IPS进行防护

性能

使用CDN进行加速

使用缓存技术减少请求

使用负载均衡进行分流

使用异步处理技术提高并发

文档

提供API文档

包含请求和响应的示例

包含错误码和错误信息

包含版本信息和更新记录

RPC编程规范

一、概述

RPC（RemoteProcedureCall）是一种远程过程调用协议

RPC编程规范是为了保证RPC调用的正确性、可靠性和高效性

二、接口设计

接口应该简单明了，易于理解和使用

接口的参数和返回值应该尽量避免使用复杂的数据类型

接口的命名应该符合规范，遵循驼峰命名法

三、传输协议

传输协议应该选择可靠性较高的协议

传输协议应该支持压缩和加密功能

传输协议的版本应该保持一致

四、序列化协议

序列化协议应该选择效率高、可扩展性好的协议

序列化协议的版本应该保持一致

序列化协议应该支持多种语言

五、错误处理

接口应该返回明确的错误信息

错误码应该具有可读性和可维护性

错误码应该分类清晰，错误码之间应该有明确的关系

六、性能优化

尽量减少网络传输的数据量

尽量减少序列化和反序列化的时间

尽量减少网络请求的次数

七、安全性

传输协议和序列化协议应该支持加密功能

接口应该进行鉴权，防止非法调用

接口应该进行参数校验，防止恶意攻击

八、版本管理

接口的版本应该进行管理

接口的变更应该进行记录和通知

接口的兼容性应该进行测试和验证

九、日志记录

记录接口的调用情况和错误情况

记录接口的性能指标

记录接口的版本信息

十、测试和验证

接口的测试应该覆盖所有情况

接口的测试应该进行压力测试

接口的测试应该进行兼容性测试输出：RPC编程规范一、概述RPC（RemoteProcedureCall）是一种远程过程调用协议RPC编程规范是为了保证RPC调用的正确性、可靠性和高效性二、接口设计接口应该简单明了，易于理解和使用接口的参数和返回值应该尽量避免使用复杂的数据类型接口的命名应该符合规范，遵循驼峰命名法三、传输协议传输协议应该选择可靠性较高的协议传输协议应该支持压缩和加密功能传输协议的版本应该保持一致四、序列化协议序列化协议应该选择效率高、可扩展性好的协议序列化协议的版本应该保持一致序列化协议应该支持多种语言五、错误处理接口应该返回明确的错误信息错误码应该具有可读性和可维护性错误码应该分类清晰，错误码之间应该有明确的关系六、性能优化尽量减少网络传输的数据量尽量减少序列化和反序列化的时间尽量减少网络请求的次数七、安全性传输协议和序列化协议应该支持加密功能接口应该进行鉴权，防止非法调用

URL Routing命名规范

URLRouting命名规范

URLRouting的基本原则

可读性

可维护性

可扩展性

唯一性

一致性

URLRouting的命名规范

URL的结构

模块名

控制器名