C# 代码注释规范

不要小瞧注释，因为自己写的Code在很长时间后在修改时，可能连自己都记不得了，还有在其他人接手自己的Case的时候，也会造成阅读困难；
   .NET提供四种注释
   一：类注释-在类的开始部分注释
     /*
     * 类说明
     *
     *
     */
   public class City
   {}
   二：类属性注释-在类的属性前注释
   //属性说明
   public string City_Name
     {
         get { return this._city_name; }
         set { this._city_name = value; }
     }
   三：类方法注释-在类的方法声明前注释
   /// <summary>
   /// 方法说明
   /// </summary>
   public void Insert()
   {}
   四：代码间注释-在代码之间注释
        try
            {
                //<说明>
                ListViewItem lvi = Getlvi(car);
                this.lvCar.Items.Add(lvi);
            }
            catch (MessageException ex)
            {
                MessageBox.Show(ex.Message);
            }
每天学习一点点，每天进步一点点

 

1 using 上面的注释

//

// 名称： LeaveMessageMannage

// 描述： 业务逻辑类[bll](实体类[model], 数据访问类[bal])

// 创建人：张园园

// 创建时间：2008-08-27

// 最后修改人：（无）

// 最后修改时间：（无）

// 版权所有 (C) :

大连锦程软件技术开发有限公司

2 方法注释

#region 插入留言信息

        /// <summary>

        /// 插入数据

        /// </summary>

        /// <param name="model"></param>

        定义方法

#endregion