經常使用工具說明--jsdoc 前端文檔輸出工具

1.利用npm安裝jsdoc模塊

npm install jsdoc -g

 

2.因爲jsdoc默認的生成文檔模板很差看，能夠下載一套好看些的模板，如 jaguar.js

下載地址： https://github.com/davidshimjs/jaguarjs-jsdoc

也可用npm下載

 

3.將node_modules/jsdoc/templates/default下面的內容刪除掉，而後將第二步下載的所有內容放在裏面

 

4.建立jsdoc的配置文件

創建一個conf.json

{

    "tags": {

        "allowUnknownTags": true

    },

    "source": {

        "include": ["lib"],

        "includePattern": ".+\\.js(doc)?$",

        "excludePattern": "(^|\\/|\\\\)_"

    },

        "templates": {

                "cleverLinks": true,

                "monospaceLinks": true,

                "default": {

                        "outputSourceFiles" : true

                },

                "applicationName": "demo",

                "openGraph": {},

                "meta": {}

        }

}

保存在根目錄下。

 

5.cmd下輸入 jsdoc -c conf.json，生成的out文件夾就是文檔生成的位置。

 

 

JSDoc中文文檔： http://www.css88.com/doc/jsdoc/about-configuring-default-template.html