【大家看看】,小生总结了下命名惯例和规范。
命名惯例和规范 Pascal 大小写形式-所有单词第一个字母大写,其他字母小写。
Camel 大小写形式-除了第一个单词,所有单词第一个字母大写,其他字母小写。
变量和方法参数Camel 大小写形式-除了第一个单词,所有单词第一个字母大写,其他字母小写。
类名使用Pascal 大小写形式
public class HelloWorld{ ...}
方法使用Pascal 大小写形式
public class HelloWorld { void SayHello(string name) { ... }}
用有意义的,描述性的词语来命名变量
- 别用缩写。用name, address, salary等代替 nam, addr, sal
- 别使用单个字母的变量象i, n, x 等. 使用 index, temp等
用于循环迭代的变量例外:
for ( int i = 0; i < count; i++ ){ ...}
- 变量名中不使用下划线 (_) 。
- 命名空间需按照标准的模式命名
文件名要和类名匹配
例如,对于类HelloWorld, 相应的文件名应为 helloworld.cs (或, helloworld.vb)
缩进用 TAB . 不用 SPACES.。
注释需和代码对齐.。
花括弧 ( {} ) 需和括号外的代码对齐.。
用一个空行来分开代码的逻辑分组,如string name = “a”;
在一个类中,各个方法需用一空行,也只能是一行分开。
花括弧需独立一行,而不像if, for 等可以跟括号在同一行。.
好: if ( ... ) { // Do something }
不好: if ( ... ) { // Do something }
在每个运算符和括号的前后都空一格。.
好: if ( showResult == true ) { for ( int i = 0; i < 10; i++ ) { // } }
不好: if(showResult==true) { for(int i= 0;i<10;i++) { // } }
避免使用大文件。如果一个文件里的代码超过300~400行,必须考虑将代码分开到不同类中。
避免写太长的方法。一个典型的方法代码在1~25行之间。如果一个方法发代码超过25行,应该考虑将其分解为不同的方法。
方法名需能看出它作什么。别使用会引起误解的名字。如果名字一目了然,就无需用文档来解释方法的功能了。
好:void SavePhoneNumber ( string phoneNumber ) { // Save the phone number. }
不好:// This method will save the phone number. void SaveData ( string phoneNumber ) { // Save the phone number. }
一个方法只完成一个任务。不要把多个任务组合到一个方法中,即使那些任务非常小。
好:// Save the address. SaveAddress ( address ); // Send an email to the supervisor to inform that the address is updated. SendEmail ( address, email ); void SaveAddress ( string address ) { // Save the address. // ... } void SendEmail ( string address, string email ) { // Send an email to inform the supervisor that the address is changed. // ... }
不好:// Save address and send an email to the supervisor to inform that the address is updated. SaveAddress ( address, email ); void SaveAddress ( string address, string email ) { // Job 1. // Save the address. // ... // Job 2. // Send an email to inform the supervisor that the address is changed. // ... }
使用C# 或 VB.NET的特有类型,而不是System命名空间中定义的别名类型。
好:int age; string name; object contactInfo;
不好:Int16 age; String name; Object contactInfo;
别在程序中使用固定数值,用常量代替。
避免使用很多成员变量。声明局部变量,并传递给方法。不要在方法间共享成员变量。如果在几个方法间共享一个成员变量,那就很难知道是哪个方法在什么时候修改了它的值。
别把成员变量声明为 public 或 protected。都声明为 private 而使用 public/protected 的Properties.
不在代码中使用具体的路径和驱动器名。 使用相对路径,并使路径可编程。
应用程序启动时作些“自检”并确保所需文件和附件在指定的位置。必要时检查数据库连接。出现任何问题给用户一个友好的提示。
显示给用户的消息要简短而友好。但要把所有可能的信息都记录下来,以助诊断问题。
别每行代码,每个声明的变量都做注释。在需要的地方注释。可读性强的代码需要很少的注释。如果所有的变量和方法的命名有意义,会使代码可读性很强并无需太多注释。
行数不多的注释会使代码看起来优雅。但如果代码不清晰,可读性差,那就糟糕。
对一个数值变量采用不是0,-1等的数值初始化,给出选择该值的理由。
简言之,要写清晰,可读的代码以致无须什么注释就能理解。
发生异常时,给出友好的消息给用户,但要精确记录错误的所有可能细节,包括发生的时间,和相关方法,类名等。
只捕捉特定的异常,而不是一般的异常。
不必每个方法都用try-catch。当特定的异常可能发生时才使用。比如,当你写文件时,处理异常FileIOException.
别写太大的 try-catch 模块。如果需要,为每个执行的任务编写单独的 try-catch 模块。 这将帮你找出哪一段代码产生异常,并给用户发出特定的错误消息
占用您的时间了。
最近要做个项目,需要这类文档。网上也有不少,小生自己总结了一下,大家有什么意见可以提出来一起交流。
交流才有进步,也希望可以帮助到需要的朋友。版主考虑推荐下哈。^ ^
最后:提前祝大家新年快乐!2010加油!!!
------解决方案--------------------