程序设计代码注释与头文件

      清晰明了的代码编程，可以看做是一个程序对于编程内部人员的门面。

     作为程序编写人员，你的代码不是给自己看的，是给其他相关程序人员看的。所以如果你想让你的代码获得他人的好感，那就必须先规范自己的代码。规范的代码编制方便代码的交流和维护，使代码美观而有逻辑，阅读方便，更易于理解。

    像我们现在试用的VS2012本身对于代码就有比较人性化的设计，程序人员编写的程序块或语句，它会根据内容自动缩进。而在代码中占据相当重要位置的是注释，它绝对不是可有可无的，它是程序员与日后的程序读者之间通信的重要手段。

          一、比如在每个程序类或者模块的开头部分的头文件就是对程序整体的说明。它的一些基本内容是必须包含的：

'**********************************************' 文  件  名：$safeitemname$' 命名空间：$rootnamespace$' 功       能：' 作       者：XXX' 小       组：XX' 生成日期：$time$' 版  本  号：V1.0.0.0' 修改日志：'**********************************************

        对于编程人员来说，这个头文件是以后的编程中必须要用到的，所以就应该找个办法让其自动生成，这样就不需要每次的复制粘贴了。以我的VB.net为例，找到VS的安装位置。在这里可以对接口，对类等加入所需的头文件

     
    

       以文本文档的方式打开所在文件夹的Class.VB，将上方的头文件模板复制到其中，并保存。当再次在.NET中加入新的类时，就会自动出现了这个头文件。

                                   

     

    二、模块间的注释，如方法，属性等，需要加入注释以说明该方法或属性的用途

                                             

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

           单行注释：

              //<单行注释>   

            多行注释：

                /*多行注释1

                 多行注释2

                 多行注释3*/

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

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

                                    ///修改人：

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

                                   ///备份：

                                    /*原代码内容*/

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

                                   ///添加人： 

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

                                  代码内容

                                   ///结束：                       

     总结：大家都知道，面试时如果要想给面试官留下好的印象，最基本的就是一个人的状态或者更具体的说是一个人的着装。虽然不可否认人的内在或者说拥有的能力更加重要，但是在面试官来，他没有那么多的时间去认识你的内在，或者说如果你想让他更近一步认识你，首先你得让他对你感兴趣甚至是不反感。可想一个干净整洁的形象总是要比邋遢脏乱的形象更容易获得人们的好感度。这个道理反射到我们的代码中，其实是一样的道理。所以我们在编写代码时要从规范做起，以规范为基础，才会有更快的提高。