新手应知道的ASP.NET代码编写规范

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键，不要使用空格键。

标签：

版权申明：本站文章部分自网络，如有侵权，请联系：west999com@outlook.com
特别注意：本站所有转载文章言论不代表本站观点，本站所提供的摄影照片，插画，设计作品，如需使用，请与原作者联系，版权归原作者所有