利用JSDOC快速生成註釋文檔，很是棒。

　　有時每每咱們須要建一個文檔來記錄js中的一些代碼註釋，好比一些公共的函數，又或者一些類，在團隊合做中，文檔接口也是必不可少的，傳統的方式多少有些不便，這裏介紹一個工具，它叫JSDOC，它能夠用來將註釋生成文檔。

 

　　雖說是說它能夠把註釋生成文檔，可是也不是什麼註釋均可以的，咱們須要按照它的規範來寫。

　　首先咱們經過npm來下載它。

　　npm install jsdoc -g

　　

　　JSDOC的格式是這樣的。

　　

/**

* 兩個數相加
* @param {number} num1 加法
* @param {number} num2 被加
* @returns {number} 和

*/
function add(num1,num2){
　　return num1 + num2;
}

　　首先註釋得以/**開始，結束以*/結束。

　　@：在jsdoc中有必定的做用，就是它有一套標籤規則。如：

 

　　@param {type} n1 description

　　　　param:表示函數參數 {類型} 參數值 描述

 

　　@returns {type} description

　　　　returns:返回值 描述

    還有不少。

 

生成jsdoc文檔：cmd裏面執行jsdoc xx.js

 

會在當前目錄下生成一個out目錄，裏面有一個index.html，打開能夠看到生成的結果。

 

看見沒，仍是很清楚的。

裏面還有一個Tank構造函數其中代碼是這樣的。

/**
* 坦克類
* @constructor
* @param {number} x 座標X
* @param {number} y 座標Y
* @param {number} dire 方向
* @param {array} colors 一組顏色
*/
function Tank(x,y,dire,colors){
　　this.x = x;
　　this.y = y;
　　// 速度
　　this.steep = 5;
　　// 方向
　　this.dire = dire;
　　// 坦克顏色
　　this.colors = colors;
　　// 移動方向
　　this.moveUp = function(){
　　　　this.y-= this.steep;
　　　　this.dire = 0;
　　};
　　this.moveRight = function(){
　　　　this.x+= this.steep;
　　　　this.dire = 1;
　　};
　　this.moveDown = function(){
　　　　this.y+= this.steep;
　　　　this.dire = 2;
　　};
　　this.moveLeft = function(){
　　　　this.x-= this.steep;
　　　　this.dire = 3;
　　};
}

 

@constructor表示一個構造器，你看上面的截圖就能夠很清楚的看到它的結果是什麼樣子了。

這上面介紹的是幾個比較經常使用的，固然還有不少方法，這裏就不一一介紹了，能夠看官方文檔或者搜索一下相關的教程，這裏只是給你們入個門。