Unity和C# 项目风格规范

た入场券 2022-12-27 11:23 276阅读 0赞

微软官方的命名方式参考

### 相关地址 ###

*  [https://docs.microsoft.com/zh-cn/dotnet/standard/design-guidelines/index][https_docs.microsoft.com_zh-cn_dotnet_standard_design-guidelines_index]
 *  [https://msdn.microsoft.com/zh-cn/library/ms229002%28VS.80%29.aspx][https_msdn.microsoft.com_zh-cn_library_ms229002_28VS.80_29.aspx]
 *  [http://www.dofactory.com/reference/csharp-coding-standards][http_www.dofactory.com_reference_csharp-coding-standards]
 *  [https://blogs.msdn.microsoft.com/brada/2005/01/26/internal-coding-guidelines][https_blogs.msdn.microsoft.com_brada_2005_01_26_internal-coding-guidelines]

--------------------

# 风格指南 #

## Tabs&缩进 ##

Tab 字符(\\0x09) 不应在代码中使用。所有缩进应该用4个空格字符完成。（换句话说，一个Tab键的缩进应该用4个空格来代替）

## Bracing ##

打开花括号总是应该在开始块的语句后面的行首。大括号内容应缩进4个空格。例如：

if (SomeExpression)
            {
                DoSomething();
            }
            else
            {
                DoSomethingElse();
            }

case”语句应该像switch语句一样缩进：

switch (SomeNumber)
            {
    
                case 0:
                    DoSomething();
                    break;
                case 1:
                    DoSomethingElse();
                    break;
                case 2:
                    {
                        int n = 1;
                        DoAnotherThing(n);
                    }
                    break;
            }

大括号永远不应被视为可选项。即使对于单个语句块，您也应该始终使用大括号。这增加了代码的可读性和可维护性。(换句话说：就算一行函数也建议加上大括号)

for (int i=0; i<100; i++) { DoSomething(i); }

## 单行语句 ##

单行语句可以有在同一条线上开始和结束的括号。

public class Foo
    {
       int bar;
       public int Bar
       {
          get { return bar; }
          set { bar = value; }
       }
    }

> 据建议，所有的控制结构（if, while, for, etc）使用大括号，但它不是必需的。

## 评论 ##

评论应该用来描述意图，算法概述和/或逻辑流程。 如果仅通过阅读评论，作者以外的人可以理解功能的预期行为和一般操作，那将是理想的。虽然没有最低评论要求，当然也有一些非常小的程序根本不需要评论，但希望大多数程序都会有反映程序员意图和方法的评论。（就是说说这些函数干什么的，为什么这么写，当时怎么想的）

//-----------------------------------------------------------------------
    // <copyright file="ContainerControl.cs" company="Microsoft">
    //     Copyright (c) Microsoft Corporation.  All rights reserved.
    // </copyright>
    //-----------------------------------------------------------------------

### 文件评论 (可以理解为代码注释) ###

所有方法都应该使用XML文档注释。对于内部开发者评论，应该使用<devdoc>标签

public class Foo 
    {
    /// <summary>Public stuff about the method</summary>
    /// <param name=”bar”>What a neat parameter!</param>
    /// <devdoc>Cool internal stuff!</devdoc>
    ///
    public void MyMethod(int bar) { … }
    }

UNDONE§有一个大文档，里面有我们应该使用的所有评论标签......那是哪里？

### 评论风格 ###

该//注释标记（两个斜杠）风格应该在大多数情况下使用。在可能的情况下，将注释放在代码上方而不是旁边。 这里有些例子：

//这是WebClient通过代理工作所必需的
    GlobalProxySelection.Select = new WebProxy("http://itgproxy");

//创建访问Internet资源的对象
    WebClient myClient = new WebClient();

> 当空间允许时，注释可以放在行的末尾

public class SomethingUseful 
    {
        private int          itemHash;            // instance member
        private static bool  hasDoneSomething;    // static member
    }

## 间距 ##

空间通过减少代码密度来提高可读性。以下是在代码中使用空格字符的一些准则：

*  请在函数参数之间逗号后使用单个空格。

Right:          Console.In.Read(myChar, 0, 1);
    Wrong:       Console.In.Read(myChar,0,1);

*  不要在圆括号和函数参数后面使用空格

Right:          CreateFoo(myChar, 0, 1)
    Wrong:       CreateFoo( myChar, 0, 1 )

*  不要在函数名称和括号之间使用空格。

Right:          CreateFoo()
    Wrong:       CreateFoo ()

*  不要在括号内使用空格

Right:    x = dataArray[index];
    Wrong:       x = dataArray[ index ];

*  在流控制语句之前使用单个空格

Right:          while (x == y)
    Wrong:       while(x==y)

*  在比较运算符之前和之后使用单个空格

Right:          if (x == y)
    Wrong:       if (x==y)

## 命名 ##

遵循内部和外部成员的所有.NET Framework设计指南。其中的要点包括：

*  不要使用匈牙利符号
 *  不要为成员变量（*，m*，s\_等）使用前缀。如果你想区分本地变量和成员变量，你应该在C＃中使用“this。”和“me。“在VB.NET中
 *  请使用成员变量驼峰规则
 *  请使用camelCasing作为参数
 *  请使用局部变量驼峰规则
 *  请使用PascalCasing的函数，属性，事件和类名
 *  接口名称前缀加“I”
 *  不要在枚举，类或委托前加任何字母

> 扩展公共规则（没有匈牙利语，没有成员变量的前缀等）的原因是产生一致的源代码外观。另外一个目标是拥有干净可读的来源。代码可读性应该是主要目标。

## 命名约定 ##

### Interop类 ###

Interop包装器（DllImport语句）的类应遵循下面的命名约定：

*  **NativeMethods** 不抑制非托管代码属性，这些方法可以在任何地方使用，因为将执行堆栈审核。
 *  **UnsafeNativeMethods** 禁止非托管代码属性。这些方法具有潜在的危险性，任何这些方法的调用者都必须进行全面的安全检查，以确保使用安全并受到保护，因为不会执行堆栈审核。
 *  **SafeNativeMethods** 禁止非托管代码属性。这些方法是安全的，并且可以相当安全地使用，即使不执行堆栈审核，调用者也不需要进行全面的安全性评估

class NativeMethods 
    {
       private NativeMethods() {}
    
       [DllImport(“user32”)]
       internal static extern void FormatHardDrive(string driveName);
    }
    
    [SuppressUnmanagedCode]
    class UnsafeNativeMethods 
    {
       private UnsafeNativeMethods() {}
    
       [DllImport(“user32”)]
       internal static extern void CreateFile(string fileName);
    }
    
    [SuppressUnmanagedCode]
    class SafeNativeMethods 
    {
       private SafeNativeMethods() {}
    
       [DllImport(“user32”)]
       internal static extern void MessageBox(string text);
    }

所有互操作类必须是私有的，所有方法都必须是内部的。另外应该提供一个私有构造函数来防止实例化。

## 文件组织 ##

*  源文件应该只包含一个公共类型，尽管允许多个内部类
 *  源文件应该被赋予文件中公共类的名称
 *  目录名称应该遵循该类的命名空间

例如，我期望在"System\\Windows\\Forms\\Control.cs"找到公共类“System.Windows.Forms.Control”

*  类成员应该按照**字母顺序排列**，并分组成部分（字段，构造函数，属性，事件，方法，专用接口实现，嵌套类型）
 *  **using**语句应该在名称空间声明中

namespace MyNamespace
    {
    
        using System;
    
        public class MyClass : IFoo
        {
    
            // fields
            int foo;
    
            // constructors
            public MyClass() { … }
    
            // properties
            public int Foo { get { … } set { … } }
    
            // events
            public event EventHandler FooChanged { add { … } remove { … } }
    
            // methods
            void DoSomething() { … }
            void FindSomethind() { … }
    
            //private interface implementations
            void IFoo.DoSomething() { DoSomething(); }
    
            // nested types
            class NestedType { … }
    
        }
    
    }

## 使用 [PascalCasing][] 的类名称和方法名称 ##

> **原因：**与Microsoft的.NET Framework一致并且易于阅读

public class ClientActivity
    {
        public void ClearStatistics()
        {
            //...
        }
        public void CalculateStatistics()
        {
            //...
        }
    }

## 使用[camelCasing][]的方法参数和局部变量 ##

> **原因：**与Microsoft的.NET Framework一致并且易于阅读

public class UserLog
    {
        public void Add(LogEvent logEvent)
        {
            int itemCount = logEvent.Items.Count;
            // ...
        }
    }

## 不要在标识符中使用[Hungarian ][Hungarian]符号或者任何其他类型标识 ##

> **原因：**与Microsoft的.NET Framework和Visual Studio IDE一致，使得确定类型变得非常简单（通过工具提示）。一般来说，你应该避免任何标识符中的类型指示符。

// 正确写法
    int counter;
    string name;
     
    // 错误写法
    int iCounter;
    string strName;

## 不要将Screaming Caps（这个我也不知道怎么翻译，大概的意思是全部大写）用于常量或只读变量 ##

> **原因：** 与微软的.NET Framework一致。Screaming Caps过于密集不方便阅读

// 正确
    public static const string ShippingType = "DropShip";
     
    // 错误
    public static const string SHIPPINGTYPE = "DropShip";

## 避免使用缩写。一般用到缩写的地方如：Id, Xml, Ftp, URL(这个确实重要，例如：BT，在这项目中我怎么理解？！变态？按钮？Big Tag？ WTF！！！) ##

> **原因：** 与Microsoft的.NET Framework保持一致并防止缩写不一致。

// 正确
    UserGroup userGroup;
    Assignment employeeAssignment;
     
    // 错误
    UserGroup usrGrp;
    Assignment empAssignment;
     
    // 例外
    CustomerId customerId;
    XmlDocument xmlDocument;
    FtpHelper ftpHelper;
    UriPart uriPart;

## 使用PascalCasing缩写3个或更多字符（2个字符都是大写） ##

> **原因：** 与微软的.NET Framework一致。全部大写在视觉上过度关注

HtmlHelper htmlHelper;
    FtpTransfer ftpTransfer;
    UIControl uiControl;

## 不要在标识符中使用下划线 ##

> **原因：** 与微软的.NET Framework一致，使代码更加自然地阅读

// 正确
    public DateTime clientAppointment;
    public TimeSpan timeLeft;
     
    // 错误
    public DateTime client_Appointment;
    public TimeSpan time_Left;

## 使用 **predefined type names** 而不是系统类型名称，如Int16, UInt64等 ##

> **原因：** 与Microsoft的.NET Framework一致，使代码更加自然。

// 正确
    string firstName;
    int lastIndex;
    bool isSaved;
     
    // 错误
    String firstName;
    Int32 lastIndex;
    Boolean isSaved;

## 使用隐式VAR局部变量声明。例外：原始类型（int，string，double等）使用预定义的名称。（不过笔者不建议这么弄，看上去表达不清晰,当然单从观赏性来讲Var是个不错的选择） ##

> **原因：**消除混乱，特别是复杂的泛型类型。使用Visual Studio工具提示可轻松检测类型。

var stream = File.Create(path);
    var customers = new Dictionary();
     
    // Exceptions
    int index = 100;
    string timeSheet;
    bool isCompleted;

## 使用名词或名词短语来命名一个类 ##

> **原因：**与Microsoft的.NET Framework一致并且易于记忆。

public class Employee
    {
    }
    public class BusinessLocation
    {
    }
    public class DocumentCollection
    {
    }

## 用字母I 做接口的前缀（你要是不写I编辑器都会提醒你 ）。接口名称是名词（短语）或形容词。 ##

> **原因：**与微软的.NET Framework一致。

public interface IShape
    {
    }
    public interface IShapeCollection
    {
    }
    public interface IGroupable
    {
    }

## 根据他们的主要类来命名源文件。例外：具有部分类的文件名反映它们的来源或目的，例如designer, generated等。(换句话说就是有嵌套类的时候命名按照他们父类的名称来，例外说的就是见名知意，尽量减少让阅读者看到这个类猜这个类是干什么的~) ##

> **原因：**符合微软的做法。文件按字母顺序排列，部分类保持相邻。

// Located in Task.cs
    public partial class Task
    {
        //...
    }

// Located in Task.generated.cs
    public partial class Task
    {
        //...
    }

## 用一个清晰定义的结构来组织命名空间(就是说要分类划分，就像动画系统里面的命名功能不能写到UI系统里面一样) ##

> **原因：**与微软的.NET Framework一致。保持良好的代码库组织.

// Examples
    namespace Company.Product.Module.SubModule
    namespace Product.Module.Component
    namespace Product.Layer.Module.Group

## 垂直对齐大括号。 ##

class Program
    {
        static void Main(string[] args)
        {
        }
    }

## 在类的顶部声明所有成员变量，用在最高层的静态变量。 ##

> **原因：** 普遍接受的做法，防止需要寻找变量声明。

public class Account
    {
        public static string BankName;
        public static decimal Reserves;
     
        public string Number {get; set;}
        public DateTime DateOpened {get; set;}
        public DateTime DateClosed {get; set;}
        public decimal Balance {get; set;}
     
        // Constructor
        public Account()
        {
            // ...
        }
    }

## 使用单数名字枚举。例外：位字段枚举。 ##

> **原因：**与Microsoft的.NET Framework一致，使代码更加自然阅读。多个标志，因为枚举可以保存多个值（使用按位、或）。（这个笔记不是很清楚什么意思）

// Correct
    public enum Color
    {
        Red,
        Green,
        Blue,
        Yellow,
        Magenta,
        Cyan
    }
     
    // Exception
    [Flags]
    public enum Dockings
    {
        None = 0,
        Top = 1, 
        Right = 2, 
        Bottom = 4,
        Left = 8
    }

## 明确指定枚举的类型或枚举的值（除了位域） ##

> **原因：**在依赖实际类型和值时会造成混淆

// 错误
    public enum Direction : long
    {
        North = 1,
        East = 2,
        South = 3,
        West = 4
    }
     
    // 正确
    public enum Direction
    {
        North,
        East,
        South,
        West
    }

## 不要在枚举名称后缀再次添Enum ##

> **原因：**与Microsoft的.NET Framework保持一致，与在标识符中没有类型指标的规则一致。（但是在unity中一般在Button的变量字段后缀都添加Button，例如Button openButton = null;）

// 错误
    public enum CoinEnum
    {
        Penny,
        Nickel,
        Dime,
        Quarter,
        Dollar
    }
     
    // 正确
    public enum Coin
    {
        Penny,
        Nickel,
        Dime,
        Quarter,
        Dollar
    }

*  **组件等字段使用驼峰命名**
    
    ![format_png][]
    
     
 *  **方法命名使用帕斯卡命名**
    
    ![format_png 1][]

*  **bool 变量推荐以is作为前缀，当然在unity的官方命名中也有很多不以is作为前缀的变量**
    
    ![format_png 2][]
    
     
 *  **命名所包含的含义应该见名知意，看到名称就可以最大程度的猜测出其表达含义，尽可能的不用缩写（再次强调），前面也有过介绍**
    
    ![format_png 3][]
    
     
 *  **名称是名词（短语）或形容词,更容易让人理解**
    
    ![format_png 4][]
    
     
 *  **按钮相关方法事件以OnClick结尾,原因是更方便的在众多方法中找到按钮相关的方法**
    
    ![format_png 5][]

![format_png 6][]

链接：https://www.jianshu.com/p/a00075f55a03

[https_docs.microsoft.com_zh-cn_dotnet_standard_design-guidelines_index]: https://links.jianshu.com/go?to=https%3A%2F%2Fdocs.microsoft.com%2Fzh-cn%2Fdotnet%2Fstandard%2Fdesign-guidelines%2Findex
[https_msdn.microsoft.com_zh-cn_library_ms229002_28VS.80_29.aspx]: https://links.jianshu.com/go?to=https%3A%2F%2Fmsdn.microsoft.com%2Fzh-cn%2Flibrary%2Fms229002%2528VS.80%2529.aspx
[http_www.dofactory.com_reference_csharp-coding-standards]: https://links.jianshu.com/go?to=http%3A%2F%2Fwww.dofactory.com%2Freference%2Fcsharp-coding-standards
[https_blogs.msdn.microsoft.com_brada_2005_01_26_internal-coding-guidelines]: https://links.jianshu.com/go?to=https%3A%2F%2Fblogs.msdn.microsoft.com%2Fbrada%2F2005%2F01%2F26%2Finternal-coding-guidelines
[PascalCasing]: https://baike.baidu.com/item/PascalCase/2421609?fr=aladdin
[camelCasing]: https://baike.baidu.com/item/camelCase/636859?fr=aladdin
[Hungarian]: https://baike.baidu.com/item/%E5%8C%88%E7%89%99%E5%88%A9%E5%91%BD%E5%90%8D%E6%B3%95/7632397?fr=aladdin
[format_png]: /images/20221120/6ecb017f8e2140fb837f1fbeeef77593.png
[format_png 1]: /images/20221120/5fc6495e957d4ef08c4ebd7b4ef03b3a.png
[format_png 2]: https://img-blog.csdnimg.cn/img_convert/4076a744b143a2a3446a85b36642c13c.webp?x-oss-process=image/format,png
[format_png 3]: https://img-blog.csdnimg.cn/img_convert/8512d4bb497a6e16da50cd70191f52d9.webp?x-oss-process=image/format,png
[format_png 4]: https://img-blog.csdnimg.cn/img_convert/224bcb1f23739657c77bad9cbc04b64d.webp?x-oss-process=image/format,png
[format_png 5]: https://img-blog.csdnimg.cn/img_convert/1465fc27e8b37d129f9481bc6d688f15.webp?x-oss-process=image/format,png
[format_png 6]: https://img-blog.csdnimg.cn/img_convert/224f5bc006111f958d9311355e2f4dcb.webp?x-oss-process=image/format,png