Google开源的C编码样式指南
你好,这里是Dotnet工具箱,定期分享Dotnet有趣,实用的工具和组件,希望对您有用!
这份指南适用于Google内部开发使用的C代码,并且是Google中C代码的默认样式。指南涵盖了代码,文件,命名空间,变量,文件组织方式等。
命名规则
命名规则遵循Microsoft官方的C命名指南,在Microsoft的命名指南没有指定的地方(比如私有变量和局部变量),规则是参考CoreFXC编码指南。
微软文档命名指南:
https:learn。microsoft。comzhcndotnetstandarddesignguidelinesnamingguidelines
CoreFXC编码指南:
https:github。comdotnetruntimeblobmaindocscodingguidelinescodingstyle。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虽然很方便,但有时要考虑到可读性,看看下面的例子。
鼓励使用
当类型很明显时,比如spanstylecolor:rgb(147,199,99);fontweight:700;varspanapplespanstylecolor:rgb(147,199,99);fontweight:700;newspanApple();
或者spanstylecolor:rgb(147,199,99);fontweight:700;varspanrequestFactory。CreateHttpRequest();
或者是传递给其他方法的临时变量,比如spanstylecolor:rgb(147,199,99);fontweight:700;varspanitemGetItem();
ProcessItem(item);
不鼓励使用
使用基础类型的时候,比如spanstylecolor:rgb(147,199,99);fontweight:700;varspansuccessspanstylecolor:rgb(147,199,99);fontweight:700;truespan;
或者想让用户很容易的知道类型时,使用强类型更好。spanstylecolor:rgb(147,199,99);fontweight:700;varspanlistOfItemsGetList();
方法参数
方法需要传入多个参数时,考虑使用一个类组织它,看看下面的例子。spanstylecolor:rgb(129,142,150);可读性差span
DecimalNumberproductCalculateProduct(values,spanstylecolor:rgb(255,205,34);7span,spanstylecolor:rgb(147,199,99);fontweight:700;falsespan,spanstylecolor:rgb(147,199,99);fontweight:700;span);
对比spanstylecolor:rgb(129,142,150);可读性更好span
ProductOptionsoptionsspanstylecolor:rgb(147,199,99);fontweight:700;newspanProductOptions();
options。PrecisionDecimalsspanstylecolor:rgb(255,205,34);7span;
options。UseCacheCacheUsage。DontUseCache;
DecimalNumberproductCalculateProduct(values,options,completionDelegate:spanstylecolor:rgb(147,199,99);fontweight:700;span);
项目地址
在Dotnet工具箱公众号内,回复0214,即可获取项目地址。
Dotnet工具箱
分享点收藏