Unity项目代码书写规范

以Google的代码规范为主，稍加改动 https://google.github.io/styleguide/csharp-style.html

书写规范

基础写法

  1. Pascal和驼峰混用，参数用驼峰写法，除参数外，都以Pascal写法为主。
  2. 括号建议用换行方式书写

 

Code

  • 类, 方法, 枚举, public 字段, public 属性, 命名空间的命名规则用: PascalCase.
  • 局部变量，函数参数命名规则用: camelCase.
  • private, protected, internal and protected internal 字段和属性的命名规则用: _camelCase.
  • 命名规则不受const, static, readonly等修饰符影响.
  • 对于缩写，也按PascalCase 命名，比如 MyRpc而不是MyRPC.
  • 接口以I,开头..

Files

  • 文件和文件夹 命名规则为PascalCase, 例如 MyFile.cs.
  • 文件名尽量和文件中主要的类名一直, 例如 MyClass.cs.
  • 通常，一个文件中一个类.

 

Organization

  • 如果出现，修饰符按下列顺序书写: public protected internal private new abstract virtual override sealed static readonly extern unsafe volatile async.
  • 命名空间在最顶部，using顺序按Sytem，Unity，自定义的命名空间以及字母顺序排序，
  • 类成员的顺序:
    • Group按下列顺序:
      • Nested classes, enums, delegates and events.
      • Static, const and readonly fields.
      • Fields and properties.
      • Constructors and finalizers.
      • Methods.
    • 每个Group内，按下列顺序:
      • Public.
      • Internal.
      • Protected internal.
      • Protected.
      • Private.
    • 接口的实现尽可能安排写在一起

注释规范

代码头部注释
文件名称：文件的名称。
功能描述：文件的功能描述与大概流程说明。
作者：创建并编写的人员。
日期：创建并编写的日期。
修改记录：若类有所修改，则需要有修改人员的名字、修改日期及修改理由。

// 文件名称：UserInput.cs

// 功能描述：玩家输入按键的定义

// 编写作者：张三

// 编写日期：2017.7.16

// 修改记录：

//      R1:

//          修改作者：李四

//          修改日期：2017.7.17

//          修改理由：使玩家可以自定义输入按键

 

Using System;

方法注释

采用 /// 形式自动产生XML标签格式的注释。包括方法功能，参数含义，返回内容

    /// <summary>

    /// 设置场景的名字.

    /// </summary>

    /// <returns><c>true</c>, 场景名字设置成功, <c>false</c> 场景名字设置失败.</returns>

    /// <param name="sceneName">场景名字.</param>

    public bool SetSceneName(string sceneName)

    {

}

类变量注释

采用 /// 形式自动产生XML标签格式的注释变量含义。

    /// <summary>

    /// 场景的名字

    /// </summary>

    private string mSceneName;

局部变量注释

在变量声明语句的后面注释，与前后行变量声明的注释左对齐，注释与代码间以Tab隔开。

string firstName;   //姓

string lastName;    //名

代码行注释

注释位于代码上行，与代码开始处左对齐，双斜线与注释之间以空格分开

//设置场景的名字。

this.mSceneName = sceneName;

书写示例：

  1. using System;                                           //using写在整个文件最前，多个using按下面层级以及字母排序
  2. using System.Collections;                               //1.system提供的
  3. using System.Collections.Generic;
  4. using UnityEngine;                                      //2.unity提供的
  5. using UnityEngine.UI;
  6. using GameDataModule;                                   //3.自定义的namespace
  7.  
  8. namespace MyNamespace 								    // Namespaces 命名规则为 PascalCase.  
  9. {      
  10. 	public interface IMyInterface                       // Interfaces 以 'I' 开头
  11. 	{          
  12. 		public int Calculate(float value, float exp);   // 方法函数 命名规则为 PascalCase 
  13. 	}
  14.  
  15. 	public enum MyEnum                                  // Enumerations 命名规则为 PascalCase.
  16. 	{                                  
  17. 		Yes = 0,                                        // Enumerations 命名规则为 PascalCase，并显示标注对应值
  18. 		No = 1,
  19. 	}
  20.  
  21. 	public class MyClass 								// classes 命名规则为 PascalCase.
  22. 	{                          
  23. 		public int Foo = 0;                             // Public 公有成员变量命名规则为 PascalCase.
  24. 		public bool NoCounting = false;                 // 最好对变量初始化.
  25. 		private class Results 
  26. 		{
  27. 			public int NumNegativeResults = 0;
  28. 			public int NumPositiveResults = 0;
  29. 		}
  30. 		private Results _results;                       // Private 私有成员变量命名规则为 _camelCase.
  31. 		public static int NumTimesCalled = 0;
  32. 		private const int _bar = 100;                   // const 不影响命名规则.
  33. 		private int[] _someTable =                  
  34. 		{       
  35. 			2, 3, 4,                 
  36. 		}
  37. 		public MyClass()                                // 构造函数命名规则为 PascalCase.
  38. 		{
  39. 			_results = new Results                      // 对象初始化器最好用换行的方式赋值.
  40. 			{
  41. 				NumNegativeResults = 1,                 // 操作符前后用个空格分割.  
  42. 				NumPositiveResults = 1,           
  43. 			};
  44. 		}
  45.  
  46.     public int CalculateValue(int mulNumber) 
  47. 	{      
  48.         var resultValue = Foo * mulNumber;              // Local variables 局部变量命名规则为camelCase.
  49.         NumTimesCalled++;
  50.         Foo += _bar;
  51.         if (!NoCounting)                                // if后边和括号用个空格分割.
  52. 	    {                                                                          
  53. 			if (resultValue < 0)
  54. 			{                                                                  
  55. 				_results.NumNegativeResults++        
  56. 			} 
  57. 			else if (resultValue > 0)
  58. 			{         
  59. 				_results.NumPositiveResults++;
  60. 			}
  61. 		}
  62. 		return resultValue;
  63.     }
  64.  
  65.     public void ExpressionBodies() 
  66. 	{
  67.       //对于简单的lambda，如果一行能写下，不需要括号
  68.       Func<int, int> increment = x => x + 1;
  69.  
  70.       // 对于复杂一些的lambda，多行书写.
  71.       Func<int, int, long> difference1 = (x, y) => 
  72. 	  {
  73.           long diff = (long)x - y;
  74.           return diff >= 0 ? diff : -diff;
  75.       };
  76.     }
  77.  
  78.     void DoNothing() {}                             // Empty blocks may be concise.
  79.  
  80.     
  81.     void CallingLongFunctionName() 
  82. 	{
  83.       int veryLongArgumentName = 1234;
  84.       int shortArg = 1;
  85.       // 函数调用参数之间用空格分隔
  86.       AnotherLongFunctionNameThatCausesLineWrappingProblems(shortArg, shortArg, veryLongArgumentName);
  87. 	  // 如果一行写不下可以另起一行，与第一个参数对齐
  88.       AnotherLongFunctionNameThatCausesLineWrappingProblems(veryLongArgumentName, 
  89. 															veryLongArgumentName, veryLongArgumentName);
  90.     }
  91.   }
  92. }

 

 

 

 

 

 

 

posted @ 2021-06-17 17:40  yassine  阅读(323)  评论(0)  编辑  收藏  举报