ASP.NET的9条代码编写规范
写了这么久程序代码了,发现很多人的代码很不规范。尤其在几个人协作开发一个项目的时候,有些 人写的类名、变量名、方法等令人根本看不懂,可能会弄的整个项目都没法组合完成。自认为我的写的代 码已经很不错了,至少能够见名知意。不过,看完这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键,不要使用空格键。 |
凌众科技专业提供服务器租用、服务器托管、企业邮局、虚拟主机等服务,公司网站:http://www.lingzhong.cn 为了给广大客户了解更多的技术信息,本技术文章收集来源于网络,凌众科技尊重文章作者的版权,如果有涉及你的版权有必要删除你的文章,请和我们联系。以上信息与文章正文是不可分割的一部分,如果您要转载本文章,请保留以上信息,谢谢! |