C#编码规范和编程好习惯(1) - 51CTO.COM

51CTO首页 | 论坛 | 博客 | 技术圈 | 求职 | 读书 | 技术频道 | CIO | 导航

首页 | Java | .Net | Web | XML | 语言工具 | 测试 | 游戏 | 移动 | 架构 | 项目管理 | 全部文章

您所在的位置：首页>>开发>>.Net>>

C#编码规范和编程好习惯(1)

http://developer.51cto.com 2007-03-06 13:42 杨贺宏 Csdn 我要评论(0)

摘要：本文讲述了C#编码的命名惯例和规范，比如文件名要和类名匹配，一些良好的编程习惯，相关注释和异常处理。供大家参考！
标签：C# 编码规范习惯

谁都会写代码！几个月的编程经验可以让你写出“可运行应用程序”。让它可运行容易，但是以最有效率的方式编码就需要下更多的功夫！

要知道，大多数程序员在写“可运行代码”而不是“高效代码”。我们在这个指南课程前面提到，你想成为你们公司“最尊贵的专业人员”吗？写“高效代码”是一项艺术，你必须学习和实践它。

命名惯例和规范

注记：Pascal 大小写形式－所有单词第一个字母大写，其他字母小写。

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

类名使用Pascal 大小写形式

public class HelloWorld
{ ...}

方法使用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等。

用于循环迭代的变量例外：

for ( int i = 0; i < count; i++ )
{
 ...
}

如果变量只用于迭代计数，没有在循环的其他地方出现，许多人还是喜欢用单个字母的变量(i) ，而不是另外取名。

- 变量名中不使用下划线 (_) 。

- 命名空间需按照标准的模式命名
...

文件名要和类名匹配

例如，对于类HelloWorld, 相应的文件名应为 helloworld.cs (或, helloworld.vb)

缩进和间隔

缩进用 TAB 不用 SPACES。

注释需和代码对齐。

花括弧 ( {} ) 需和括号外的代码对齐。

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

bool SayHello (string name) 
{
string fullMessage = "Hello " + name;  DateTime currentTime = DateTime.Now;  
    string message = fullMessage + ", the time is : " + currentTime.ToShortTimeString();
    MessageBox.Show ( message );  
    if ( ... )  
{   
        // Do something   // ...   return false;  
    }  return true; 
}

这段代码看起来比上面的好：

bool SayHello ( string name )
 {
  string fullMessage = "Hello " + name;
  DateTime currentTime = DateTime.Now;
  
string message = fullMessage + ", the time is : " + currentTime.ToShortTimeString();
  
MessageBox.Show ( message );
  
if ( ... )
  {
   // Do something
   // ...
   
return false;
  }
  
return true;
 }

在一个类中，各个方法需用一空行，也只能是一行分开。

共3页: 1 [2] [3] 下一页

【内容导航】

上一篇： VC++开发的应用技巧三则放送下一篇：浅析C#中的Delegate

C#实用基础教程

网络安全产品检验规范

C#技术开发指南

深入Vista应用程序开发

走向银光 —— 一步一步学Silverlight2

查看所有评论(0 )

频道推荐

全站热点

ARP攻击防范与解决方案

ARP攻击防范与..

SOA 面向服务架构

SOA 面向服务..

技术人

Google十周年：..

求职必杀技决战..

读书

Visual C++ 完全自学宝典
作者：强锋科技,朱洪波
Visual C++ 6.0是微软公司为程序人员提供的Visual Studio 6.0工具套件中的重要组成部分。本书由浅入深地介绍使用Visual C++ 6.0..

优秀博文

最新热帖

技术快讯

Copyright©2005-2008 51CTO.COM 版权所有