编码规范
# 编码规范
# 后端
# 1、命名规范
表达清晰是命名规范的核心,常见的命名分格有:
# 1.1 Pascal 风格
包含一到多个单词,每一个单词第一个字母大写,其余字母小写。例如:HelloWorld
# 1.2 Camel 风格
包含一个到多个单词,第一个单词首字母小写,其余单词首字母大写。例如:name
, userPhone
。
除了参数与变量之外,所有命名空间,类,函数,接口,属性等名称的命名,使用
Pascal
风格,参数与变量的命名使用Camel
风格
私有字段需要已
_
开头,如:private string _name;
# 2、通用命名约定
约定的是如何选择最适当的名称
# 2.1 命名方式
2.1.1 选择容易读的英文名称,可读性比详细描述重要。例如:
ScreenX
比ScreenHorizontally
更具有可读性
2.1.2 除了下画线之外,不要使用连字符或者其他非字母数字字符
2.1.3 避免使用与常用编程语言的关键字冲突的标识符
2.1.4 变量和方法参数使用
Camel
风格
2.1.5 不要使用成员变量属性作为成员变量的前缀(其他变量命名也一样)。例如:不要像
Users m_users
这样定义成员变量,应该是Users userModel
# 2.2 字母缩写
通常不要使用缩写,除非这种缩写已被广泛接受,或者团队当中大家都认可一种缩写。
# 2.3 命名空间命名
命名空间的命名采用Pascal
风格,取名规则为Td.ProjectName
,需要用复数时,使用复数;例如使用System.Collections
而不是System.Collection
需要缩写时,不需要加复数;例如使用System.IO
而不是System.IOs
# 2.4 类,结构和接口命名
2.4.1 按照
Pascal
大小写格式,使用名词或者名词短语为类,接口和值命名
2.4.2 接口命名以字母 I 为前缀,例如
Icomponent
2.4.3 派生类的末尾使用基类的名称。例如从
Stream
继承的Framework
类型以Stream
结尾
# 3、代码编码规范
# 3.1 适当使用空行,来增加代码的可读性
3.1.1 应该添加一行空行的情况
1.方法之间
2.局部变量和它后面的语气之间
# 前端
# 1、接口和页面目录全部采用小驼峰命名
前端的接口文件(src/api/components
里面)已经页面目录(src/views
下)全部按照小驼峰命名方式