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

最新推荐文章于 2020-01-05 21:32:40 发布

weixin_30799995

最新推荐文章于 2020-01-05 21:32:40 发布

阅读量72

点赞数

CC 4.0 BY-SA版权

原文链接：http://www.cnblogs.com/x2048/articles/1794059.html

本文介绍了ASP.NET开发中的九条编码规范，包括变量和方法的命名、大小写问题等。良好的编码习惯有助于提升团队开发效率。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

优秀的代码规范和编程风格可以让我们在团队开发中提高效率。本文总结了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键，不要使用空格键。

转载于:https://www.cnblogs.com/x2048/articles/1794059.html