Unity C#编码规范

时间:2024-03-28 11:32:14

1、脚本的主题、功能、创建者、修改者说明如下所示

Unity C#编码规范

其中:Author为脚本创建者,需要自己修改为自己的名字大写,比如小明创建了一个名为Ctrl_TrayMove的脚本,AuthorXM;

如果小李修改小明创建的Ctrl_TrayMove脚本,则Modify Recoder:XL修改那个方法的那些内容,具体就是Modify Recoder:XL修改了CheckChangeState()方法的移动内容

 

2、规范命名空间,字段的定义采用英文命名标注好字段是私有还是公有,且做好注释(注释统一在81列注明,如果超过81列的则空格3格注明),如下所示:

Unity C#编码规范

注意:①如果字段为私有字段则是_大写开头,比如定义私有字段当前状态则为:Unity C#编码规范

  ②如果字段为共有字段则是小写开头,比如定义共有字段每次测试时间则为:Unity C#编码规范

Unity C#编码规范

 

3、脚本中的方法采用///注释首先说明该方法的作用(如果方法中有参数的需要对该参数做说明)其次就是方法名称采用动词+名称方式命名,最后就是方法中的一些功能需要必要的说明,如下所示;

Unity C#编码规范

Unity C#编码规范

Unity C#编码规范