Grunt入門教程之（三）

foreverpx發表於2014-09-24

Grunt入門教程之三

Yuidoc外掛

Yuidoc 是一個可以將程式碼註釋生成HTML格式文件的工具，文件的生成完全基於JavaDoc風格的程式碼註釋規則。

我們在寫公共模組或者API的時候，往往會輸出文件給呼叫者檢視，這時候Yuidoc就是一個很好的助手。

下面介紹一下如何在Grunt中使用Yuidoc。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16




grunt.initConfig({
  pkg: grunt.file.readJSON('package.json'),
  yuidoc: {
    compile: {
      name: '<%= pkg.name %>',
      description: '<%= pkg.description %>',
      version: '<%= pkg.version %>',
      url: '<%= pkg.homepage %>',
      options: {
        paths: 'path/to/source/code/',
        themedir: 'path/to/custom/theme/',
        outdir: 'where/to/save/docs/'
      }
    }
  }
});




compile中前四個屬性比較容易理解，分別為“名字”，“描述”，“版本”，“專案主頁URL”。



options中的屬性跟yuidoc本身的屬性有關，不侷限於示例程式碼中的三個，更多的屬性請參見Yuidoc文件



path: 程式碼原始檔存放路徑

themedir：生成的HTML樣式的存放路徑

outdir：生成的HTML doc文件的存放路徑



grunt-contrib-yuidoc



文章作者：foreverpx

文章原文連結：Grunt入門教程之三

            




相關文章