Grunt入門教程之（三）
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文件的存放路徑
文章作者：foreverpx
文章原文連結：Grunt入門教程之三
相關文章
- Grunt快速入門
- grunt入門之grunt watch的使用
- Docker 實戰教程之從入門到提高(三)Docker
- Maven 教程之入門指南Maven
- 微信小程式入門教程之三：指令碼程式設計微信小程式指令碼程式設計
- git 入門教程之github 教程Github
- git 入門教程之版本控制Git
- Pymongo Tutorial & Pymongo入門教Go
- gitbook 入門教程之環境要求Git
- gitbook 入門教程之 gitbook 簡介Git
- git 入門教程之忽略檔案Git
- git 入門教程之知識速查Git
- gitbook 入門教程之快速體驗Git
- git 入門教程之分支策略Git
- git 入門教程之緊急修復Git
- git 入門教程之撤銷更改Git
- git 入門教程之分支管理Git
- git 入門教程之回到過去Git
- Phalcon入門教程之安裝
- Python教程之小白入門篇Python
- gitbook 入門教程之外掛介紹Git
- gitbook 入門教程之前置知識Git
- git 入門教程之個性化 gitGit
- git 入門教程之 git 私服搭建教程Git
- git 入門教程之變基合併Git
- git 入門教程之協同開發Git
- git 入門教程之本地倉庫Git
- git 入門教程之遠端倉庫Git
- git 入門教程之分支總覽Git
- git 入門教程之衝突合併Git
- git 入門教程之刪除檔案Git
- VisualStudioCode教程之————入門篇
- 新手請教，遊戲入門程式 c遊戲
- Hacktoberfest 之入門教學
- gitbook 入門教程之匯出電子書Git
- gitbook 入門教程之釋出電子書Git
- gitbook 入門教程之主題外掛(初稿)Git
- C++入門教程之二：變數C++變數