windows C#-默认约定(下)
隐式类型本地变量
当变量的类型在赋值右侧比较明显时,对局部变量使用隐式类型。
var message = "This is clearly a string.";
var currentTemperature = 27;
当类型在赋值右侧不明显时,请勿使用 var。 请勿假设类型明显来自方法名称。 如果变量类型是 new 运算符、对文本值的显式强制转换或赋值,则将其视为明确的变量类型。
int numberOfIterations = Convert.ToInt32(Console.ReadLine());
int currentMaximum = ExampleClass.ResultSoFar();
不要使用变量名称指定变量的类型。 它可能不正确。 请改用类型来指定类型,并使用变量名称来指示变量的语义信息。 以下示例应对类型使用 string,并使用类似 iterations 的内容指示从控制台读取的信息的含义。
var inputInt = Console.ReadLine();
Console.WriteLine(inputInt);
避免使用 var 来代替 dynamic。 如果想要进行运行时类型推理,请使用 dynamic。
在 for 循环中对循环变量使用隐式类型。
下面的示例在 for 语句中使用隐式类型化。
var phrase = "lalalalalalalalalalalalalalalalalalalalalalalalalalalalalala";
var manyPhrases = new StringBuilder();
for (var i = 0; i < 10000; i++)
{manyPhrases.Append(phrase);
}
//Console.WriteLine("tra" + manyPhrases);
不要使用隐式类型化来确定 foreach 循环中循环变量的类型。 在大多数情况下,集合中的元素类型并不明显。 不应仅依靠集合的名称来推断其元素的类型。
下面的示例在 foreach 语句中使用显式类型化。
foreach (char ch in laugh)
{if (ch == 'h'){Console.Write("H");}else{Console.Write(ch);}
}
Console.WriteLine();
对 LINQ 查询中的结果序列使用隐式类型。 关于 LINQ 的部分说明了许多 LINQ 查询会导致必须使用隐式类型的匿名类型。 其他查询则会产生嵌套泛型类型,其中 var 的可读性更高。
注意不要意外更改可迭代集合的元素类型。 例如,在 foreach 语句中从 System.Linq.IQueryable 切换到 System.Collections.IEnumerable 很容易,这会更改查询的执行。
我们的一些示例解释了表达式的自然类型。 这些示例必须使用 var,以便编译器选取自然类型。 即使这些示例不太明显,但示例必须使用 var。 文本应解释该行为。
将 using 指令放在命名空间声明之外
当 using 指令位于命名空间声明之外时,该导入的命名空间是其完全限定的名称。 完全限定的名称更加清晰。 如果 using 指令位于命名空间内部,则它可以是相对于该命名空间的,也可以是它的完全限定名称。
using Azure;namespace CoolStuff.AwesomeFeature
{public class Awesome{public void Stuff(){WaitUntil wait = WaitUntil.Completed;// ...}}
}
假设存在对 WaitUntil 类的引用(直接或间接)。
现在,让我们稍作改动:
namespace CoolStuff.AwesomeFeature
{using Azure;public class Awesome{public void Stuff(){WaitUntil wait = WaitUntil.Completed;// ...}}
}
今天的编译成功了。 明天的也没问题。 但在下周的某个时候,前面(未改动)的代码失败,并出现两个错误:
- error CS0246: The type or namespace name 'WaitUntil' could not be found (are you missing a using directive or an assembly reference?)
- error CS0103: The name 'WaitUntil' does not exist in the current context
其中一个依赖项已在命名空间中引入了此类,然后以 .Azure 结尾:
namespace CoolStuff.Azure
{public class SecretsManagement{public string FetchFromKeyVault(string vaultId, string secretId) { return null; }}
}
放置在命名空间中的 using 指令与上下文相关,使名称解析复杂化。 在此示例中,它是它找到的第一个命名空间。
CoolStuff.AwesomeFeature.Azure
CoolStuff.Azure
Azure
添加匹配 CoolStuff.Azure 或 CoolStuff.AwesomeFeature.Azure 的新命名空间将在全局 Azure 命名空间前匹配。 可以通过向 using 声明添加 global:: 修饰符来解决此问题。 但是,改为将 using 声明放在命名空间之外更容易。
namespace CoolStuff.AwesomeFeature
{using global::Azure;public class Awesome{public void Stuff(){WaitUntil wait = WaitUntil.Completed;// ...}}
}
样式指南
一般情况下,对代码示例使用以下格式:
- 使用四个空格缩进。 不要使用选项卡;
- 一致地对齐代码以提高可读性;
- 将行限制为 65 个字符,以增强文档上的代码可读性,尤其是在移动屏幕上;
- 将长语句分解为多行以提高清晰度;
- 对大括号使用“Allman”样式:左和右大括号另起一行。 大括号与当前缩进级别对齐;
- 如有必要,应在二进制运算符之前换行;
注释样式
- 使用单行注释(//)以进行简要说明;
- 避免使用多行注释(/* */)来进行较长的解释;
- 代码示例中的注释未本地化。 这意味着不会翻译代码中嵌入的说明。 较长的解释性文本应放在配套文章中,以便对其进行本地化;
- 若要描述方法、类、字段和所有公共成员,请使用 XML 注释;
- 将注释放在单独的行上,而非代码行的末尾;
- 以大写字母开始注释文本;
- 以句点结束注释文本;
- 在注释分隔符 (//) 与注释文本之间插入一个空格,如下面的示例所示;
// The following declaration creates a query. It does not run
// the query.
布局约定
好的布局利用格式设置来强调代码的结构并使代码更便于阅读。 Microsoft 示例和样本符合以下约定:
- 使用默认的代码编辑器设置(智能缩进、4 字符缩进、制表符保存为空格);
- 每行只写一条语句;
- 每行只写一个声明;
- 如果连续行未自动缩进,请将它们缩进一个制表符位(四个空格);
- 在方法定义与属性定义之间添加至少一个空白行;
- 使用括号突出表达式中的子句,如下面的代码所示;
if ((startX > endX) && (startX > previousX))
{// Take appropriate action.
}
例外情况出现在示例解释运算符或表达式优先级时。