Grunt-jsdoc生成JS API文檔

Grunt-jsdoc生成JS API文檔

具體的請看官網 https://github.com/krampstudio/grunt-jsdoc

一：首先確保本機電腦上是否已經安裝了nodejs和npm。具體安裝過程能夠看以下：

http://www.cnblogs.com/tugenhua0707/p/3497488.html

二： 在安裝grunt-jsodc以前，咱們先要安裝grunt，所以我在F盤下 新建文件夾gruntJSDoc 其中根目錄裏面新建一個package.json文件，內容以下：

{

  "name": "gruntJs",

  "version": "1.0.0",

  "devDependencies": {

    "grunt": "~0.4.0"

  }

}

接着進入目錄執行 npm install 演示以下：

所以在gruntJSDoc根目錄下會生成一個node_modules文件夾，以下所示：

再接着在命令行中安裝grunt-jsdoc插件，代碼以下：

 npm install grunt-jsdoc@beta --save-dev

演示以下：

如上，說明已經安裝成功了！

如今咱們再來看看package.json內容以下：

{
  "name": "gruntJs",
  "version": "1.0.0",
  "devDependencies": {
    "grunt": "~0.4.0",
    "grunt-jsdoc": "^0.6.3"
  }
}

看到多了一個grunt-jsdoc插件了；

假如我如今在根目錄下有一個src文件夾，裏面存放全部的js文件，須要把全部的js文件生成doc文檔，如今咱們只是爲了演示，因此須要一個js文件便可，以下，存放test.js

代碼以下：

/**
  @class 字符串
  @constructs
  @param {String} input 字符
  @augments System.Object
  @exports String as System.String
  */
 var String = function(input) {
  
 }

如今咱們須要在根目錄下新建 Gruntfile.js文件，內容以下：

module.exports = function(grunt) {
    // 配置
    grunt.initConfig({
        jsdoc : {
            dist : {
                src: ['src/*.js'], 
                options: {
                    destination: 'doc'
                }
            }
        }
    });

      // 載入jsdoc插件，生成JS文檔
      grunt.loadNpmTasks('grunt-jsdoc');

      // 註冊任務
      grunt.registerTask('default', ['jsdoc']);
  };

最後進入根目錄 執行grunt命令便可生成文件doc；以下所示：

生成以下文檔：

三：JSDoc介紹：

JSDoc是一個根據javascript文件中註釋的信息，生成API文檔的工具。生成的文檔是html文件。如上test.js.html文件。

   使用標籤:

   標籤就是一些以@開頭的命令；若是你想描述方法的參數，能夠這樣使用。

  /**

   *@param {type} something – something’s name

   */

function hello(something) {}

上面的 something 是參數名；{type} 是參數的類型；something’s name 是參數的描述；

用法就是 @param {類型} 參數名  參數描述

{類型1 | 類型2} 表示多個類型

@fileoverview 這是一個特殊的標記，若是在文件的第一個文檔中使用這個標記，則指定該文檔快的餘下部分將用來提供文件的一個概述。

@return 方法的返回值

用法：@return {類型} 返回值描述

 

@file 文件描述

用法： @file 文件描述

 

@todo 描述一些要作的事情

用法： @todo 描述信息

 

@author 做者

用法：@author 做者

 

@constructor 代表這個方法是一個構造器

用法: @constructor

 

@version 指定版本號

用法：@version 1.0.0

 

@class 提供類的有關信息，用在構造函數的文檔中。

@private 表示這個函數或類是私有的

@type  指定函數的返回類型；