在實際開發中，我們在定義一些類或組件時，經常要寫一些註釋。前端註釋如下：
/**
* @property {String} 日程擁有者的ID
* @desc 用於加載日程信息時指定 擁有者
* ### 示例:'T001'
*/
ownerID: null,
/**
* @property {Array} 日程擁有者的ID 數組
* @desc 用於加載日程信息時指定 擁有者
* # 示例:['T001']
*/
ownerArr: [],
/**
* @property {String} 日程顯示及添加類型
* @desc 用於加載日程信息時指定類型 以及 新建時固定類型
* @value `plan` 計劃 `act` 活動
* ### 示例:'plan'
*/
type: null,
當鼠標懸浮在其上時，可以看到這些註釋信息
可以看到有 @property @desc 等等標籤 還有些是 ###
爲什麼會有這些？主要由於有一種參考規範
註釋語法規範
1.jsDoc
整體js註釋規範參照的是 jsDoc
像是參數註釋說明可以用 @param
/**
* @func
* @desc 一個需要string類型參數的函數
* @param {string} a - 參數a
*/
function bar(a) {}
其他的具體規範可以參考 jsDoc 規範導航
2.markDown
在實際寫一些描述時，用到的是markDown語法來標記
例如，想聲明 示例時 可以用 ###
/**
* @property {String} 日程擁有者的ID
* @desc 用於加載日程信息時指定 擁有者
* ### 示例:'T001'
*/
### 就是markDown 裏 用於聲明標題信息的
具體MarkDown語法 可以參考 markDown語法大全簡版
js註釋
1.前端在VS Code開發的話，可以使用Document This 插件
2.在擴展裏搜“Document”,然後安裝，安裝好後，重啓VS Code,
3.然後將鼠標光標放置在需要添加註釋說明的方法前（或上部）,使用 Ctrl + Alt + D ，生成模板後填寫必要信息
ps:快捷鍵 也可以自己去 Vs Code【快捷鍵】設置調整
服務端方法添加說明註釋
有時我們經常會在一些服務端的方法裏看到一些註釋，像如下c#例子：
#region 重載公告的緩存
/// <summary>
/// 重載公告的緩存
/// </summary>
/// <param name="reload"></param>
public static void WriteNoticeMemory(bool reload)
{
}
#endregion
這些註釋的作用啥？
#region + #endregion
僅是用來包裹方法體的，可以將一段很長的包裹起來，方便整體閱讀
summary
用於外部調用方法時，顯示提示，
當鼠標懸浮在方法名上 就會顯示的提示
summary的添加方式：
在方法名前輸入 /// 後點回車即可
