对.Net平台开发实践的总结

以下是本人对.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:"盘运行程序。

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

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

注释

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

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

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

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

时间: 2024-08-01 03:33:09

对.Net平台开发实践的总结的相关文章

.Net平台开发实践的一些点滴总结(技术规范与实践精华)第1/2页_实用技巧

以下是本人对.Net平台开发实践的一些点滴总结.这里的技术规范主要是开发过程的代码规范.数据库设计规范.Com和.Net互操作规范:实践精华是对技术实践过程中的部分总结. 一.代码规范 良好的代码风格来自于同一的代码规范.风格良好的代码不仅具备可读性和可维护性,同时也给人行云流水.赏心悦目之快感. 据Microsoft公司统计,基于微软平台的开发中,有70-80%的印度工程师在完成同类算法或者模块时,使用的代码基本一致:而相同的调查中只有20%的中国工程师们是基本一致的.这说明我们的代码生产过程

.Net平台开发的技术规范与实践

以下是本人对.Net平台开发实践的一些点滴总结.这里的技术规范主要是开发过程的代码规范.数据库设计规范.Com和.Net互操作规范:实践精华是对技术实践过程中的部分总结. 一.代码规范 良好的代码风格来自于同一的代码规范.风格良好的代码不仅具备可读性和可维护性,同时也给人行云流水.赏心悦目之快感. 据Microsoft公司统计,基于微软平台的开发中,有70-80%的印度工程师在完成同类算法或者模块时,使用的代码基本一致:而相同的调查中只有20%的中国工程师们是基本一致的.这说明我们的代码生产过程

微信公众平台开发(107) 分享到朋友圈和发送给好友

关键字:微信公众平台 JSSDK 发送给朋友 分享到朋友圈 onMenuShareTimeline onMenuShareAppMessage 作者:方倍工作室 原文:http://www.cnblogs.com/txw1958/p/weixin-js-sharetimeline.html    在这篇微信公众平台开发教程中,我们将介绍如何在网页中实现发送给朋友和分享到朋友圈时内容参数自定义的功能. 本文分为以下二个部分: 生成JS-SDK权限验证签名 实现发送给朋友和分享到朋友圈时内容参数自定

微信公众平台开发最佳实践(第2版)

  <微信公众平台开发最佳实践 第2版>微信公众平台开发经典之作全新改版,精心挑选最经典的商业项目开发,成千上万人次微信公众平台开发者从中受益 方倍工作室已出版本书的第3版电子版,内容更多,价格更优惠,欢迎查看购买,地址:http://www.cnblogs.com/txw1958/p/buy-ebook.html       前言 出版说明 自从方倍工作室在博客园推出微信公众平台开发系列教程后,受到广大微信开发人员及爱好者的热情关注,相关文章的日访问量高达2万人次,而<微信公众平台开发

微信公众平台开发最佳实践

<微信公众平台开发最佳实践>共分10章,案例程序采用广泛流行的PHP.MySQL.XML.CSS.JavaScript.HTML5等程序语言及数据库实现.系统完整地介绍微信公众平台基础接口.自定义菜单.高级接口.微信支付.分享转发等所有相关技术,以生活类.娱乐类.企业类微信开发为切入点,讲解了30多个功能或应用案例. 前言 自从方倍工作室在博客园推出微信公众平台开发系列教程后,受到广大微信开发人员及爱好者的热情关注,相头文章的日访问量高达上万人次,而<微信公众平台开发入门教程>一门

《微信公众平台开发最佳实践》——导读

前 言 出版说明 自从方倍工作室在博客园推出微信公众平台开发系列教程后,受到广大微信开发人员及爱好者的热情关注,相关文章的日访问量高达2万人次,而<微信公众平台开发入门教程>的阅读量超过50万,博客访问量总计超过500万,成为微信公众平台开发更新最快,传播最广.受众最多.资料最全的博客,很多博文被许多有影响力的网站转载,并被各大搜索引擎收录且排名靠前,这些是我们始料未及的. 然而更让人高兴的是,很多开发者通过学习我们的教程掌握了微信公众平台开发技术,并且通过微信开发赚到了钱.2013年10月1

《微信公众平台开发:从零基础到ThinkPHP5高性能框架实践》——2.2 程序开发基础

2.2 程序开发基础 PHP(超文本预处理器,Hypertext Preprocessor)于1994年由Rasmus Lerdorf创建,他也被称为"PHP之父".PHP是一种通用开源脚本语言.其语法吸收了C语言.Java和Perl的特点,便于学习,使用广泛,主要适用于Web开发领域.PHP是最受欢迎的Web开发语言之一,也是微信公众平台开发使用最广泛的语言. SQL是结构化查询语言(Structured Query Language)的简称,它是一种数据库查询和程序设计语言,用于存

《微信公众平台开发最佳实践》——第3章 基 础 接 口 3.1 接收用户消息

第3章 基 础 接 口 基础接口是微信公众账号在申请后就默认拥有而不需要通过微信认证获得的接口.微信公众平台开发者中心启用之后,需要使用基础接口实现基本消息的接收与发送.基础接口包括三个主要的部分:接收用户消息,发送被动响应消息,接收事件推送消息.本章将介绍这三个部分是如何实现的. 3.1 接收用户消息 微信公众账号能够接收用户发送的六种格式的消息:文本(包括表情).图片.语音.视频.地理位置.链接.下面将分别介绍这六种消息. 3.1.1 文本消息 用户向微信公众账号发送文本消息的示例如图3-1

滑屏 H5 开发实践九问

  滑屏的交互形式自从在 H5 中流行起来,便广泛应用在产品宣传.广告.招聘和活动运营等场景中,作为微信朋友圈广告惯用的形式,其影响力更是得到了强化与放大.如今滑屏H5可谓玲琅满目,数不尽数. 作为一个 UI工程师,接过很多类似的项目,也曾写过滑屏的插件,在经历了不同的需求的"洗礼"并踩过若干个坑之后,不禁反问自己:应该如何面对每一次类似的需求,在已有的经验下如何做到体验更好?如何节省工作量提高效率?面对性能优秀的 iOS 与性能良莠不齐的 Android 平台,又如何做到体验统一与性