广州北大青鸟

- 联系电话 - - 来校路线 - 广州市天河区五山路金华园区3楼307
您现在的位置: 广州北大青鸟华工金华园校区 >> .net培训 >> .net文章 >> 正文
ASP.NET应该遵守的9条代码编写规范 作者:佚名    .net培训来源:本站原创    点击数:    更新时间:2017-1-6

  写了这么久程序代码了,发现很多人的代码很不规范。尤其在几个人协作开发一个项目的时候,有些人写的类名、变量名、方法等令人根本看不懂,可能会弄的整个项目都没法组合完成。自认为我的写的代码已经很不错了,至少能够见名知意。不过,看完这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键,不要使用空格键。

ACCP课程 |BENET课程| 网站地图 Copyright 2006-2017 All Rights Reserved 广州青大教育信息咨询有限公司备案/许可证编号为粤ICP备11070650号-22北大青鸟北京总部:北京阿博泰克北大青鸟信息技术有限公司 广州北大青鸟官方网址:www.gzbdqn.com.cn学校地址:广州市天河区五山路华南理工大学科技园金华园区3楼307(华工南门)