编码规范（程序猿手册）

程序开发是需要与别人合作共同开发的，所以代码规范可以提高。多个人合作的时候的开发效率，也方便后期其他人对你开发的这个程序进行维护。

 自建代码文件注释

对于自己创建的代码文件（如函数、脚本），在文件开头，一般编写如下注释：

/*************************************************

作者：

小组： 

说明：

创建日期：

版本号：

**********************************************/

1. 1. 标准注释

在模块、类、属性、方法前一行添加注释，以便调用的时候提示用户

下以方法声明做例子：

        /// <summary>

        /// depiction：<对该方法的说明>

        /// </summary>

        /// <param name="<参数名称>"><参数说明></param>

             /// <returns>

             ///<对方法返回值的说明，该说明必须明确说明返回的值代表什么含义>

      /// </returns>

如果模块只进行部分少量代码的修改时，则每次修改须添加以下注释：

///修改人：

///修改日期：< YYYY-MM-DD >

 ///备份：

/* 原代码内容*/

将原代码内容注释掉，然后添加新代码使用以下注释：

///添加人： 

///添加日期： <YYYY-MM-DD> 

代码内容

///结束：                      

对于重构的类文件，需要对原来的类文件做备份，然后放在同级目录下，在原有文件名后面添加后缀＂_BAK＂，以便日后版本升级时整理源码。

1. 1. 代码间注释

代码间注释分为单行注释和多行注释：

单行注释：

//<单行注释>

多行注释：

     /*多行注释1

     多行注释2

     多行注释3*/

代码中遇到语句块时必须添加注释（if,for,foreach,……）,添加的注释必须能够说明此语句块的作用和实现手段（所用算法、循环条件、不同分支的意义等等）。

注释的好处：

1 方便合作开发软件

2 方便后期维护

3 缩短了开发时间

命名规范

   控件命名

变量，常量，方法等等。

    类，接口命名控件等等

这些内容都涉及到了，命名规范的问题。

使用命名规范的好处

1 对于控件命名的话，在我们写代码使用到控件的时候可以非常清晰的分清楚哪个控件是干什么用的，职责分明。而不用，在设计界面一通乱找。最后还没找到。

2 变量和常量命名，体现在合作开发的时候。不同猜测这个功能是干嘛的，而可以根据你的命名规则就可以体现出。这个变量或者这个方法具体的作用或功能。

3  还是上面注释的好处一样，可以提高开发效率。大大的缩短了开发时间，也做到了有效沟通。

编码风格规范：

还是保持一个原则，遵从大多数人都可以使用的原则。而是个性化，因为程序写完之后是需要大家共同来维护的。所以使用标准化和官方定义不会产生二义性，也不会产生不必要的分歧。

文章来源: kangshihang.blog.csdn.net，作者：康世行，版权归原作者所有，如需转载，请联系作者。

原文链接：kangshihang.blog.csdn.net/article/details/103829538