c#學習筆記--Visual Studio 中的代碼注釋

一、注釋

1.代碼的單行注釋，用//;  

2.代碼的多行注釋。可點擊頂站菜單欄

或者（ctrl+e,c取消用ctrl+e,u）

3.程序代碼分塊，用#region注釋；用#endregion結束

4.類代碼塊注釋結構和類描述信息

• 4.1全局常量注釋
• 4.2私有變量注釋
• 4.3共有變量注釋
• 4.4共有方法注釋

5待實現功能注釋：//HACK(修改)   //UNDONE （沒有做完）  //TODO（未實現）添加注釋標識有未完成代碼，以便於全局搜索標籤（task list）找到這段代碼進行完善

6修改別人代碼注釋：添加修改注釋，標明修改人。時間和描述

例子代碼：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
namespace ConsoleApplication1
{
    /// <summary>
    /// 功能描述：xx類
    /// 創建者：xxx 2018-04-24
    /// 審查者:xxx  審查時間
    /// </summary>
    class program
    {
        static void main(string[] args)
        {
        #region(全局常量)
        /// <summary>
        /// XXX數據庫名稱
        /// </summary>
        public const string CONST_xxx_SQLNAME = "QuTanBaoDB";
        #endregion
         #region(私有變量)
        /// <summary>
        /// 用戶名稱
        /// </summary>
        private string userName = "string.Empty";
        #endregion
         #region(共有變量)
        /// <summary>
        /// 用戶年齡
        /// </summary>
        public int userAge = 0;
        #endregion
         #region(共有方法)
        /// <summary>
        /// 根據用戶ID獲取用戶名稱
        /// </summary>
        /// <param name="userID"></param>
        /// <returns>成功與否</returns>
        public string GetUserName(string userID)
        {
            return this.userName;
        }
        #endregion
          public string GetUserName(string userID)
        {
             //TODO:xxx
            return this.userName;
        }
          public string GetUserName(string userID)
        {
             //edit by xxx 2018-04-23:解決xxx問題
            return this.userName;
        }
        }
    }
}