C#编码标准规范.docVIP

C#编码规范 Pascal 大小写 将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用 Pascal 大小写。例如： BackColor Camel 大小写 标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如： backColor 匈牙利方法（不要使用） 多数程序员喜欢把数据类型作为变量名的前缀而m_作为成员变量的前缀，例如： string m_sName;int nAge; 然而，这种方式在.NET编码规范中是不推荐的。所有变量都用camel 大小写形式 ? 良好的编程习惯遵从以下良好的习惯以写出好程序 ? 避免使用大文件。如果一个文件里的代码超过300～400行，必须考虑将代码分开到不同类中。 ? 避免写太长的方法。一个典型的方法代码在1～25行之间。如果一个方法发代码超过25行，应该考虑将其分解为不同的方法。 ? 方法名需能看出它作什么。别使用会引起误解的名字。如果名字一目了然，就无需用文档来解释方法的功能了 ?一个方法只完成一个任务。不要把多个任务组合到一个方法中，即使那些任务非常小。 ?使用C# 或 VB.NET的特有类型，而不是System命名空间中定义的别名类型。好： int age; string name; object contactInfo; 不好： Int16 age; String name; Object contactInfo; ? 别在程序中使用固定数值，用常量代替。 ? 别用字符串常数。用资源文件。 ? 避免使用很多成员变量。声明局部变量，并传递给方法。不要在方法间共享成员变量。如果在几个方法间共享一个成员变量，那就很难知道是哪个方法在什么时候修改了它的值。 ? 必要时使用enum 。别用数字或字符串来指示离散值。 好： enum MailType { Html, PlainText, Attachment } void SendMail (string message, MailType mailType) { 　switch ( mailType ) { case MailType.Html: // Do something break; case MailType.PlainText: // Do something break; case MailType.Attachment: // Do something break; default: // Do something break; } } 不好： void SendMail (string message, string mailType) { switch ( mailType ) { case Html: // Do something break; case PlainText: // Do something break; case Attachment: // Do something break; default: // Do something break; } } ? 别把成员变量声明为 public 或 protected。都声明为 private 而使用 public/protected 的Properties. ? 不在代码中使用具体的路径和驱动器名。 使用相对路径，并使路径可编程。 ? 永远别设想你的代码是在“C:”盘运行。你不会知道，一些用户在网络或“Z:”盘运行程序。 ? 应用程序启动时作些“自检”并确保所需文件和附件在指定的位置。必要时检查数据库连接。出现任何问题给用户一个友好的提示。 ? 如果需要的配置文件找不到，应用程序需能自己创建使用默认值的一份。 ? 如果在配置文件中发现错误值，应用程序要抛出错误，给出提示消息告诉用户正确值。 ? 错误消息需能帮助用户解决问题。永远别用象应用程序出错, 发现一个错误 等错误消息。而应给出象 更新数据库失败。请确保登陆id和密码正确。 的具体消息。 ? ? 显示错误消息时，除了说哪里错了，还应提示用户如何解决问题。不要用 象 更新数据库失败。这样的，要提示用户怎么做：更新数据库失败。请确保登陆id和密码正确。 ? 显示给用户的消息要简短而友好。但要把所有可能的信息都记录下来，以助诊断问题。 ?不要使用匈牙利方法来命名变量 ? 当一行被分为几行时，通过将串联运算符放在每一行的末尾而不是开头，清楚地表示没有后面的行是不完整的。 ?