ASP.NET应该遵守的9条代码编写规范

开发 后端
优秀的代码规范和编程风格可以让我们在团队开发中提高效率。本文总结了ASP.NET开发中的九条编码规范,包括变量和方法的命名、大小写问题等。

写了这么久程序代码了,发现很多人的代码很不规范。尤其在几个人协作开发一个项目的时候,有些人写的类名、变量名、方法等令人根本看不懂,可能会弄的整个项目都没法组合完成。自认为我的写的代码已经很不错了,至少能够见名知意。不过,看完这9条后我觉得我还得进一步学习学习了...

1.局部变量的名称要有意义,尽量用对应的英文命名,比如“用户姓名”变量,不要用aa bb cc等来命名,而要使用userName。

2.不要使用单个字母的变量,如i、n、x等。而要使用index、temp等。用于循环迭代的变量例外。

3.应该使用Pascal命名法命名方法名、属性名、类名和命名空间,且方法的命名一般将其命名为动宾短语,如

◆ShowDialog();
◆CreateFile();
◆GetPath();

4.用Camel命名法命名局部变量和方法的参数。

以上几条综合举例如下

public class Neeke 
{ 
    public Neeke() 
    { 
         
    } 
  
    private string neekeName; 
  
    public string NeekeName 
    { 
        get { return neekeName; } 
        set { neekeName = value; } 
    } 
  
    public void CallMe() 
    { 
        System.Console.WriteLine("Hello Neeke!"); 
    } 
}

5.仅使用匈牙利命名法对WinForm和Web空间命名,禁止使用textbox1、gridview1等默认命名。

6.接口命名以大小写I作为前缀,如INeeke,以便直观的区分接口和类。

7.使用命名空间的层次性结构来组织各种类和接口。

正确:

using Www.Ineeke.Cn;
namespace Ineeke.Cn
{
 ...
}

错误:

using WwwIneekeCn;
namespace IneekeCn
{
 ...
}

8.所有代码必须保证有足够的注释,注释量要求在15%以上。需要注释的内容包括以下几种。

1)关键性语句(如关键的变量声明,条件判断等)。
2)类名前的文档注释(以//开头的注释)包括类的简单功能说明、使用方法等。
3)具有复杂参数列表的方法。

9.代码缩进用Tab键,不要使用空格键。

【编辑推荐】

  1. C#编码规范和编程好习惯
  2. 专题:ASP.NET MVC框架
  3. ASP.NET六大实用技巧
责任编辑:佚名 来源: Neeke's Blog
相关推荐

2011-07-14 11:27:50

java

2009-08-03 17:07:13

ASP.NET编程规范

2009-08-03 16:57:42

ASP.NET编程规范

2011-05-19 09:20:21

VB.NETASP.NET

2009-08-04 11:29:14

HTML代码ASP.NET控件

2009-08-04 17:16:16

ASP.NET代码优化

2009-07-30 14:26:30

ASP.NET常用代码

2009-07-22 17:35:23

代码隐藏文件ASP.NET

2009-07-22 17:45:35

ASP.NET教程

2009-07-29 15:26:43

ASP.NET连接Or

2009-07-30 14:32:18

ASP.NET常用代码

2009-07-28 17:17:19

ASP.NET概述

2009-08-03 14:22:33

什么是ASP.NET

2009-08-10 17:17:10

ASP.NET安装部署

2009-07-27 12:22:03

ASP.NET和ASPASP.NET入门教程

2011-06-28 15:06:09

ASP.NET网站优化

2009-07-27 10:22:16

ASP.NET中Coo

2009-08-10 15:26:46

ASP.NET组件编程

2009-07-27 15:48:43

2009-07-29 11:19:03

JavaScriptASP.NET
点赞
收藏

51CTO技术栈公众号