程序员必知的注释规范

        前段时间就想着写写关于代码注释的博客，却迟迟没有写，一方面是因为这些实践性的内容，单靠总结意义不大；另一方面，总觉得注释是最基础的知识，一直在这里磨蹭也不是回事。但是反过来想想，最基础的反而是最欠缺的，以前做的东西，有很多存在注释不规范问题。

        注释不规范的原因也很多：工程留给的时间不多；觉得繁琐，写了没什么用……这些都是浅层次的原因，深度挖掘，根本原因在自身的素质：浮躁、急功近利、舍本逐末。大家应该有过这样的经历，注释不全的情况下，自己开发的系统，6个月以后再修改，想抽自己；合作开发的系统，要修改别人的代码，想抽别人。

        以下以C#为例，说说代码的注释规范，其它语言类似。规范是死的，人是活的，每个公司也会根据自己的情况制定不同的规则，把握一个原则：站在别人的角度可以看懂代码。

/************************************************* 
 * 作者：LIDA
 * 公司：第八工作室
 * 说明：本模块用于展示常用的代码注释方式
 * 创建日期：2012年11月18日
 * 版本号：V1.0
 * **********************************************/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Windows.Forms;

namespace 注释规范
{
    static class Program
    {
        static void Main()
        {
            /*
             * 定义用户的姓氏
             * 定义用户的名字
             * 定义用户的信息
             */
            string firstName="LI";
            string lastName = "DA";
            string fullInfo;

            //获取用户完整信息
            NotesTest test = new NotesTest();
            fullInfo=test.GetInfo(firstName,lastName);
        }
    }

    #region  块注释：此功能块用于管理用户的个人信息
    
    /// <summary>
    /// 此类用于个人信息处理
    /// </summary>
    public class NotesTest
    {

        /// <summary>
        /// 根据用户的姓氏和名字返回完整的信息
        /// </summary>
        /// <param name="firstName">姓氏</param>
        /// <param name="lastName">名字</param>
        /// <returns>完整信息</returns>