1.规范目的:
(1.1)增强代码可维护性。代码的编写不是一次性就能写得很完美的,需要不断的修复bug,修改或增加功能,重新设计整体架构等。这时就需要进入代码中去做修改,如果没有良好的代码规范,时间久了自己阅读起来就很费力。
(1.2)提高团队开发效率。大多数项目的代码都不是由一个人编写的,其他成员也许会因为项目的交接需要接手管理你所编写的代码,如果没有良好的代码规范,他人便无法快速轻松的理解你的代码。
(1.3)提高个人编码效率。最开始可能会觉得被规范约束,后来反而会因为有规范而有依靠感,不必再为起什么名字而犹豫。
2.规范说明:
(2.1)代码的规范不是绝对的,每个公司都会有自己的一套代码规范,每个新人刚进入都要最先学习代码规范,才能加入到团队的开发中来。
3.命名规范:
(3.1)基本规则(对于类、字段、方法、参数、变量):
【规则1-1】英文单词命名。禁止使用拼音或无意义的字母命名。
【规则1-2】直观易懂。使用能够描述其功能或意义的英文单词或词组。
【规则1-3】除了常量的命名以外,不要采用下划线命名法。
//命名表示 汽车类型 的字段:
int carType //正确:英文词组、能描述其意义。
int qicheleixing //错误:拼音。
int akhj //错误:无意义。
int car //错误:不能描述其意义。
int car_type //错误:下划线命名。
【规则1-4】约定俗成的变量可以 依次 简单命名。
//命名循环里的递增(减)变量:
int i,j,k;
【规则1-5】命名空间名、类名、接口名、非私有字段名、枚举名及枚举值名、方法名采用 大驼峰式命名法 ,即每一个单词的首字母都大写。
namespace Car {} //命名空间名
public class SendManager; //类名
public interface IState; //接口名
public string FirstName; //非私有字段名
enum CarDriveType {FrontWheelDrive, RearWheelDrive, FourWheelDrive}//枚举名及枚举值名
public void SendMessage(

本文详细介绍了Unity3D项目中C#代码的规范,包括规范的目的,命名规则,编码规则以及注释规则。目的是提升代码可维护性和团队开发效率,规定了如命名使用驼峰式命名法,接口命名以'I'开头,变量声明和方法定义的格式等,同时强调了注释的重要性,如文件头部、方法、变量和行注释的规范。
最低0.47元/天 解锁文章
1709





