IT猫扑网:您身边最放心的安全下载站! 最新更新|软件分类|软件专题|手机版|论坛转贴|软件发布

您当前所在位置:首页网络编程.Net编程 → .Net平台开发的技术规范与实践精华总结

.Net平台开发的技术规范与实践精华总结

时间:2015/6/28来源:IT猫扑网作者:网管联盟我要评论(0)

以下是本人对.Net平台开发实践的一些点滴总结。这里的技术规范主要是开发过程的代码规范、数据库设计规范、Com和.Net互操作规范;实践精华是对技术实践过程中的部分总结。

一、代码规范

良好的代码风格来自于同一的代码规范。风格良好的代码不仅具备可读性和可维护性,同时也给人行云流水、赏心悦目之快感。

据Microsoft公司统计,基于微软平台的开发中,有70-80%的印度工程师在完成同类算法或者模块时,使用的代码基本一致;而相同的调查中只有20%的中国工程师们是基本一致的。这说明我们的代码生产过程亟待规范。

实义命名

类型、变量、常量、方法等标识符一律采用对应的英文实义;如果涉及到两个独立的实义单词,则中间用下划线间隔或者单词首字母大写(两种方式都可以);如果标识符的长度超过了30个字母,则基本上以英文单词发音的重读音节取选出三个字母,如Repeater用rpt,Management用mgt。

大小写规则

目前一般有两种大小写规则:

Pascal大小写形式,所有单词第一个字母大写,其他字母小写。

Camel大小写形式,除了第一个单词,所有单词第一个字母大写,其他字母小写。

类名使用Pascal大小写形式

public class HelloWorld(或者Hello_World,以下同,不再赘述)
{
...
}

方法使用Pascal大小写形式

public class HelloWorld()
{
void SayHello(string name)
{
...
}
}

变量和方法参数使用Camel 大小写形式

public class HelloWorld()
{
int totalCount = 0;
void SayHello(string name)
{
string fullMessage = "Hello " + name;
...
}
}

不要使用匈牙利方法来命名变量

以前,多数程序员喜欢把数据类型作为变量名的前缀而m_作为成员变量的前缀。例如: string m_sName;int nAge;

然而,这种方式在.NET编码规范中是不推荐的。所有变量都用Camel 大小写形式,而不是用数据类型和m_来作前缀。

用name,address,salary等代替nam,addr,sal。

别使用单个字母的变量象i,n,x 等。使用 index,temp等。用于循环迭代的变量例外:

如果变量只用于迭代计数,没有在循环的其他地方出现,允许用单个字母的变量命名,而不是另外取实义名。

文件名要和类名匹配,例如,对于类HelloWorld,相应的文件名应为helloworld.cs。

缩进和间隔

缩进用TAB,不用 SPACES。

注释需和代码对齐。

遵循VS2005的自动对齐规则,不要人为的调整。

用一个空行来分开代码的逻辑分组。

在一个类中,各个方法的实现体必须用空行间隔,大括弧"{}"需独立一行。

在每个运算符和括号的前后都空一格。如:

If ( showResult == true )
{
for ( int i = 0; i < 10; i++ )
{
//
}
}

而不是:

if(showResult==true)
{
for(int i= 0;i<10;i++)
{
//
}
}

良好的编程习惯

避免使用大文件。如果一个文件里的代码超过300~400行,必须考虑将代码分开到不同类中。

避免写太长的方法。一个典型的方法代码在1~30行之间。如果一个方法发代码超过30行,应该考虑将其分解为不同的方法。

方法名需能看出它作什么。别使用会引起误解的名字。如果名字一目了然,就无需用文档来解释方法的功能了。

一个方法只完成一个任务。不要把多个任务组合到一个方法中,即使那些任务非常小。

使用C# 的特有类型,而不是System命名空间中定义的别名类型。如:

int age;

string name;

object contactInfo;

而不是:

Int16 age;

String name;

Object contactInfo;

这么做是基于如下两点原因:(1)规范性和一致性;(2)便于跨语言平台的移植。

别在程序中使用固定数值,用常量代替。别用字符串常数,尽量用资源文件。

避免使用很多成员变量,声明局部变量,并传递给方法。

不要在方法间共享成员变量,如果在几个方法间共享一个成员变量,那就很难知道是哪个方法在什么时候修改了它的值。必要时使用enum,别用数字或字符串来指示离散值。

别把成员变量声明为 public或 protected。都声明为private 而使用 public/protected 的Properties。

不在代码中使用具体的路径和驱动器名,使用相对路径,并使路径可编程。永远别设想你的代码是在"C:"盘运行。你不会知道,一些用户在网络或"Z:"盘运行程序。

应用程序启动时作些"自检"并确保所需文件和附件在指定的位置。必要时检查数据库连接,出现任何问题给用户一个友好的提示。

如果需要的配置文件找不到,应用程序需能自己创建使用默认值。如果在配置文件中发现错误值,应用程序要抛出错误,给出提示消息告诉用户正确值。错误消息需能帮助用户解决问题。

注释

别每行代码,每个声明的变量都做注释。在需要的地方注释。

可读性强的代码需要很少的注释,如果所有的变量和方法的命名都很有意义,会使代码可读性很强并无需太多注释。行数不多的注释会使代码看起来优雅。

如果因为某种原因使用了复杂艰涩的原理,必须为程序配备良好的文档和详细的注释。

对注释做拼写检查,保证语法和标点符号的正确使用。

二、数据库设计规范

表格分类与命名

数据表的分类关键词标签:.Net平台开发规范

相关阅读

文章评论
发表评论

热门文章 手把手教你用好LINQ to SQL手把手教你用好LINQ to SQL在.NET环境下为网站增加IP过滤功能在.NET环境下为网站增加IP过滤功能ASP.NET 如何避免页面重新整理时重复送出ASP.NET 如何避免页面重新整理时重复送出用Asp.net扩展ExtJS用Asp.net扩展ExtJS

相关下载

人气排行 asp.net表单提交方法GET\POST在ASP.NET中如何判断用户IE浏览器的版本Asp.net中messagebox的实现方法Asp.net中的web.config配置在ASP.NET MVC中实现大文件异步上传用Iformattable接口控制.Net中文本格式c#.Net经典面试题目用Asp.net扩展ExtJS