关于asp.net代码规范

代码写的好,方便自己,方便他人,好处我们都了解了,下面直接上内容了。

注释规范

一、模板注释:

每次新建一个类都要在开头写上关于此类的注释,例如名称、时间等,如图所示(以vs2017为例):

方法:找到相关路径(路径如下图),用记事本打开Class.cs即可进行修改:

二、代码注释

除了对每行代码做必要的注释之外,对每一个方法也要进行注释,在方法上面输入三条“/”:

        /// <summary>
        ///对该方法的描述
        /// </summary>
        /// <param name="userName">参数意义</param>
        /// <param name="userPwd">参数意义</param>        
        /// <param name="userInfo">参数意义</param>
        /// <returns></returns>
        public bool ValidateUserInfo(string userName,string userPwd,out UserInfo userInfo)
        {

            //内容
        }

 命名规范

一、什么条件下用Camel规则:

Camel:除首字母外,其他单词的首字母大写,其他字母小写。

1、当给变量命名的时候。

2、当给参数命名的时候。

3、用private、protected 声明字段的时候。 三种情况如下:

string name="计算机";//给变量命名的时候

public void Get(string name)//给参数命名的时候
{
    //内容
}

public class Persona
{
    private string name;//声明字段的时候

}

二、什么时候用Pascal

Pascal:所有单词的首字母都大写,其他字母小写。

1、给命名空间命名时。

2、给类命名的时。

3、给方法命名的时。

4、给接口命名的时(开头用I,表示Interface)。

5、给属性命名时。

6、使用委托时 。

namespace BLL//给命名空间命名
{
    public class UserInfo//给类命名时
    {

        public class GetName()//给方法命名时
        {
            public string Name{get;set;}//给属性命名时
        }
        
        public delegate in MyDelegate(int x,int y);//使用委托时
    }
    
}

 常用控件命名规范(前缀)

1、 Button——btnLogin

2、CheckBox——chkColor

3、GridView——gvwCity

4、Label——lblLogin

5、TextBox——txtLogin

6、LinkButton——lbtnLogin

7、ListBox——lstColor

如有问题,多多指教。

发布了109 篇原创文章 · 获赞 17 · 访问量 2万+

猜你喜欢

转载自blog.csdn.net/aaaPostcard/article/details/103847884