以下是本人对Net平台开发实践的一些点滴总结这里的技术规范主要是开发过程的代码规范数据库设计规范Com和Net互操作规范实践精华是对技术实践过程中的部分总结
一代码规范
良好的代码风格来自于同一的代码规范风格良好的代码不仅具备可读性和可维护性同时也给人行云流水赏心悦目之快感
据Microsoft公司统计基于微软平台的开发中有%的印度工程师在完成同类算法或者模块时使用的代码基本一致而相同的调查中只有%的中国工程师们是基本一致的这说明我们的代码生产过程亟待规范
实义命名
类型变量常量方法等标识符一律采用对应的英文实义如果涉及到两个独立的实义单词则中间用下划线间隔或者单词首字母大写(两种方式都可以)如果标识符的长度超过了个字母则基本上以英文单词发音的重读音节取选出三个字母如Repeater用rptManagement用mgt
大小写规则
目前一般有两种大小写规则
Pascal大小写形式所有单词第一个字母大写其他字母小写
Camel大小写形式除了第一个单词所有单词第一个字母大写其他字母小写
类名使用Pascal大小写形式
public class HelloWorld(或者Hello_World以下同不再赘述)
{
}
方法使用Pascal大小写形式
public class HelloWorld()
{
void SayHello(string name)
{
}
}
变量和方法参数使用Camel 大小写形式
public class HelloWorld()
{
int totalCount = ;
void SayHello(string name)
{
string fullMessage = "Hello " + name;
}
}
不要使用匈牙利方法来命名变量
以前多数程序员喜欢把数据类型作为变量名的前缀而m_作为成员变量的前缀例如 string m_sNameint nAge
然而这种方式在NET编码规范中是不推荐的所有变量都用Camel 大小写形式而不是用数据类型和m_来作前缀
用nameaddresssalary等代替namaddrsal
别使用单个字母的变量象inx 等使用 indextemp等用于循环迭代的变量例外
如果变量只用于迭代计数没有在循环的其他地方出现允许用单个字母的变量命名而不是另外取实义名
文件名要和类名匹配例如对于类HelloWorld相应的文件名应为helloworldcs
缩进和间隔
缩进用TAB不用 SPACES
注释需和代码对齐
遵循VS的自动对齐规则不要人为的调整
用一个空行来分开代码的逻辑分组
在一个类中各个方法的实现体必须用空行间隔大括弧“{}”需独立一行
在每个运算符和括号的前后都空一格如
If ( showResult == true )
{
for ( int i = ; i < ; i++ )
{
//
}
}
而不是
if(showResult==true)
{
for(int i= ;i<;i++)
{
//
}
}