如果您正在处理更大的项目并确保您可以轻松阅读团队中任何开发人员编写的代码,那么编码指南非常重要。
不幸的是,没有关于如何格式化 C# 代码的任何官方指南。微软自己在开发 .NET 框架时遇到了这个问题,并开发了一套内部样式指南,这些指南发展成为一个名为 StyleCop 的成熟程序,它有一个带有合理设置的默认规则集。
根据这些规则,您应该始终使用string
而不是String
:
string xyz;
string.Format();
规则如下:
SA1121 - UseBuiltInTypeAlias - 可读性规则
该代码使用一种基本的 C# 类型,但不使用该类型的内置别名。
不应使用类型名称或完全限定类型名称,而应始终使用这些类型的内置别名:bool、byte、char、decimal、double、short、int、long、object、sbyte、float、string , ushort, uint, ulong。
推荐阅读的是 StyleCop 的历史,您可以在此处找到:
http://stylecop.codeplex.com/wikipage?title=A%20Brief%20History%20of%20CSharp%20Style&referringTitle=Documentation
它解释了您在使用相同代码库的不同背景的不同人员时遇到的一些问题,以及他们如何开发规则集。
我们最近在自己的项目中实现了 StyleCop,虽然要真正遵守所有规则需要做很多工作,但生成的代码更具可读性。它还具有相当好的 ReSharper 集成,如果您使用 ReSharper,它允许您自动进行许多修复。