編寫可維護的javascript代碼--- 2015.11.22（註釋）

1.單行註釋

// 這是一句單行註釋

2.多行註釋

/* 這裏是代碼 */ 
   

 /*
    這裏都是註釋
　　 1232132
  */     

   java的註釋風格

/*
 * 另外一段註釋
 * 這段註釋包含2個文本 
 */

3  文檔註釋

/**
 * @method merge
 * @param {Object} 被合併的一個或多個對象
 * @return {Object} 一個新的被合併後的對象
 **/
 
 

這裏推薦你們一個地址，你們能夠去看一看 點擊查看註釋大全

 

Sublime註釋插件-Doc​Blockr

功能

生成優美註釋

簡介

標準的註釋，包括函數名、參數、返回值等，並以多行顯示，省去手動編寫

wiki

• https://github.com/spadgos/sublime-jsdocs
• https://sublime.wbond.net/packages/DocBlockr

使用方法

1.快速註釋： 輸入/*、/**（在Coffee-Script中是###*），Enter

 

2. 函數註釋：使用Tab在不一樣的字段切換

 

3. 變量註釋

 

4. 註釋+評論