C#编程的一般注意事项

最新推荐文章于 2023-09-27 15:04:31 发布

dingxy

最新推荐文章于 2023-09-27 15:04:31 发布

阅读量1.5k

点赞数

分类专栏： C# 文章标签： c# 编程 pascal xml 编译器 exception

C# 专栏收录该内容

18 篇文章

订阅专栏

本文介绍了C#编程语言中的命名规范，包括类、常量、枚举、事件等不同元素的命名约定，并详细解释了Pascal和Camel大小写机制的应用场景。此外，还介绍了如何使用XML注释来提高代码的可读性和可维护性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

区分大小写
所有变量和关键字都是区分大小写的。

命名约定
ECMA标准提供了C#代码所要遵循的命名约定原则。通过遵循严格的命名策略，不仅可以增强程序的一致性，而且可以最大程度地减少通常因随意命名而导致的大小写错误。表2ˉ1对一些较为重要的建议做了一个总结。
表2ˉ1 C#命名约定

类型	大小写机制	注意事项及示例
类	Pascal	● 使用名词或名词短语 ● 尽量避免以字母I开头，因为这种命名是为接口保留的，接口都以字母I开头 ● 不要使用下划线
常量	Pascal	public const double GramToPound=454.0
枚举类型	Pascal	● 枚举值名采用Pascal机制 ● 枚举名使用单数 public enum WarmColor｛Orange，Yellow，Brown｝
事件	Pascal	● 事件处理方法应当有EventHandler后缀 ● 事件参数类要有后缀EventArgs
异常	Pascal	● 有后缀Exception
接口	Pascal	● 有字母I作为前缀IDisposable
局部变量	Camel	● 有public修饰符的变量要采用Pascal机制int myIndex
方法	Pascal	● 用动词或动词短语来命名
命名空间	Pascal	● 命名空间和类不要同名 ● 使用前缀来避免出现同名的命名空间如，使用公司名对该公司开发的命名空间归类Acme.GraphicsLib
成员属性	Pascal	● 使用名词或名词短语
参数	Camel	● 使用可以描述参数用途的有意义的名字

注意:名字的大小写可以基于如下两种机制:
1.Pascal。每个单词的首字母大写（如MyClassAdder）。
2.Camel。除第一个单词外，每个单词的首字母大写（如myClassAdder）。
对此有一个很好的经验:除了参数和局部变量外，其他的命名均遵循Pascal大小写机制。

对C#程序加注释
C#编译器支持三种类型的嵌入注释:XML注释、加双斜杠的单行注释（//）和多行注释（/ˇˇ/），大多数程序员应该对后面两种注释都很熟悉:

XML注释以三个斜杠开头，通常包含XML标记，用于说明代码的某个特定方面，如结构、类或类成员。C#解析器能展开XML标记来提供附加信息，并将其导出到一个外部文件以便进一步处理。

如图2ˉ1所示，标记用于描述一个类型（类）。C#编译器还可以识别另外8种与特定程序元素相关的主要标记，参见表2ˉ2，这些标记直接放在所指的代码行前面。表2ˉ2 XML文档标记

使用XML注释的原因是，这些注释能导出到一个单独的XML文件中，然后可以使用标准XML解析技术来处理。默认情况下，编译器不生成XML文件，所以，如果想生成XML文件，则需要明确地告诉编译器。下面的命令会编译源代码consoleapp.cs，并创建XML文件consoleXML

from http://book.51cto.com/art/200708/52874.htm