添加注釋的目的是為了提高工作效率,便于后續開發人員開發維護以及在網站建設中,使結構更加清晰,代碼簡明有序,提高可讀性和可維護性。養成良好的注釋習慣,是作為一名開發人員必備的條件。
<br /><br />
>注釋符與注釋內容之間加一個空格,注釋行與上方代碼間加一行空行,注釋內容清晰詳細!
```
單行注釋:// 我是無敵可愛寧!
多行注釋:/* 我是無敵可愛寧!*/
```
<br />
>頂部文檔信息:包括文件描述、原始作者,如果有更新,則需要添加更新內容、更新作者和更新時間
```
/**??
* @description 文檔說明?
* @author:作者?
* @date:編譯時間
*/
```
<br />
>描述對象的屬性
```
/**??
* @var {object}??
* @property {string} a - 屬性a?
* @property {string} b - 屬性b??
*/
let foo = {?
a: 'a',?
? b: 'b'
}
```
<br />
>JS方法模塊多行注釋
```
/**??
* 函數描述
* 與此函數相關聯引入的其他函數,并說明該函數具體位置以及說明其功能
* @param:{string} 參數1的說明
* @param:{string} 參數2的說明
* @return: {Object} 返回值描述
*/
```