Google 开源的 C# 编码样式指南

你好，这里是 Dotnet 工具箱，定期分享 Dotnet 有趣，实用的工具和组件，希望对您有用！

这份指南适用于 Google 内部开发使用的 C# 代码，并且是 Google 中 C# 代码的默认样式。指南涵盖了代码, 文件, 命名空间，变量，文件组织方式等。

命名规则

命名规则遵循 Microsoft 官方 的 C# 命名指南, 在 Microsoft 的命名指南没有指定的地方（比如私有变量和局部变量），规则是参考 CoreFX C# 编码指南。

微软文档命名指南:
https://learn.microsoft.com/zh-cn/dotnet/standard/design-guidelines/naming-guidelines

CoreFX C# 编码指南:
https://github.com/dotnet/runtime/blob/main/docs/coding-guidelines/coding-style.md

代码

• •  类、方法、枚举、公共字段、公共属性、命名空间， 使用 PascalCase 格式。

• •  局部变量，防范参数，使用 camelCase 格式。

• •  私有、受保护、内部和受保护的内部字段和属性，使用 _camelCase 格式。

• •  接口名称用 字母 I 开头，比如 IInterface。

文件和组织方式

• •  文件名和目录名是 PascalCase 格式，比如 MyFile.cs。

• •  在可能的情况下，文件名应该和文件中主要类的名称是相同的。

• •  修饰符按以下顺序出现：

  • • public

  • • protected

  • • internal

  • • private

  • • new

  • • abstract

  • • virtual

  • • override

  • • sealed

  • • static

  • • readonly

  • • extern

  • • unsafe

  • • volatile

  • • async

var 关键字

var 虽然很方便，但有时要考虑到可读性，看看下面的例子。

鼓励使用

当类型很明显时，比如

var apple = new Apple();

或者

var request = Factory.Create<HttpRequest>();

或者是传递给其他方法的临时变量，比如

var item = GetItem(); 
ProcessItem(item);

不鼓励使用

使用基础类型的时候，比如

var success = true;

或者想让用户很容易的知道类型时, 使用强类型更好。

var listOfItems = GetList();

方法参数

方法需要传入多个参数时，考虑使用一个类组织它，看看下面的例子。

// 可读性差 
DecimalNumber product = CalculateProduct(values, 7, false, null);

对比

//  可读性更好
ProductOptions options = new ProductOptions();
options.PrecisionDecimals = 7;
options.UseCache = CacheUsage.DontUseCache;
DecimalNumber product = CalculateProduct(values, options, completionDelegate: null);

项目地址

在 Dotnet工具箱 公众号内，回复 0214，即可获取项目地址。

Dotnet 工具箱

扫码关注我们

分享

点收藏

点点赞

点在看