编码规范 #

空格空行: #

• 1.代码中禁止出现无意义空行.
• 2.尽量使用注释来代替空行,实在不需要注释的地方,并且与上文逻辑有明显区分的可使用空行分隔
• 3.在该打空格的地方必须打空格,比如运算符前后,等号前后,for循环中的分号后,if或者for等关键字后可以不打空格.
• 4.空格和缩进格式可使用Ctrl+K+F让VS使用默认的格式进行调整.

命名规范: #

• 1.类名命名单词首字母大写.
• 2.类成员变量以m开头,后面的单词首字母大写,必须保证单词拼写正确.
• 3.函数中的临时变量以小写开头,后面的单词首字母大写.
• 4.函数名首字母小写.
• 5.部分情况下使用缩写时允许以大写字母开头,但是仍需要尽量避免这种情况.
• 6.回调函数以on开头,非回调函数禁止以on开头.且回调函数权限为protected.
• 7.以set开头的函数应该只用于根据参数设置成员变量的值,而不能做其他的事情.
• 8.以get开头的函数尽量不要在函数内对成员变量有修改.
• 9.明确is,if,can此类单词的含义,is是否,if如果,can能否,一般用于获取一个bool状态时尽量使用is
• 10.枚举名为全大写,单词之间以下划线分隔.
• 11.枚举值为全大写,单词之间以下划线分隔,可以不使用枚举名首字母为前缀.

代码结构: #

• 1.类成员变量写在类的开头,并且访问权限为保护.
• 2.不允许在函数之间插入成员变量定义.
• 3.类函数写在成员变量之后,先写公有函数,然后加分割线,再写保护的函数.
• 4.不允许出现不同访问权限的函数混合排布.
• 5.如果一个函数的代码只有一行,则可以将整个函数写成一行,比如简单的的get和set函数
• 6.if下必须添加大括号,即使只有一行也需要添加大括号.

常量: #

• 1.禁止在代码中出现意义不明的数字,需要定义常量或者枚举来代替.
• 2.非显示类的字符串必须定义为常量.比如某个资源的名字等
• 3.不需要使用readonly标识运行时常量,一般只使用编译时常量即可

注释: #

• 1.提交的代码中禁止出现被注释的代码.
• 2.禁止使用除了双斜杠以外的注释形式.比如/**/局部注释,///注释
• 3.行注释双斜杠后需要加一个空格.
• 4.在代码逻辑不是非常浅显易懂的地方应该添加相应的注释,提高代码阅读效率.
• 5.尽量在成员变量后添加注释,用于说明此变量用处,以及使用方式等等.
• 6.成员变量注释或者枚举类型的注释需要对齐.

其他: #