Grunt入门教程之(三)
来源:互联网 发布:武汉富士康2018java 编辑:程序博客网 时间:2024/05/22 13:10
Grunt入门教程之三
Yuidoc插件
Yuidoc 是一个可以将代码注释生成HTML格式文档的工具,文档的生成完全基于JavaDoc风格的代码注释规则。
我们在写公共模块或者API的时候,往往会输出文档给调用者查看,这时候Yuidoc就是一个很好的助手。
下面介绍一下如何在Grunt中使用Yuidoc。
12345678910111213141516
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入门教程之三
0 0
- Grunt入门教程之(三)
- Grunt入门教程之(一)
- Grunt 入门教程三:GruntFile 例子
- Grunt入门教程
- Grunt入门教程之二 —— concat插件
- VB入门教程之三
- SMARTCLIENT入门教程之三
- Grunt 入门教程一:开始使用Grunt(翻译自官方教程)
- Grunt 入门教程一:开始使用Grunt(翻译自官方教程)
- grunt 入门教程五:完整示例(完结篇)
- Grunt 入门教程二:配置任务
- Grunt 入门教程四:创建任务
- 常用插件的使用—grunt入门指南之三
- grunt入门指南之三 常用插件的使用
- CCV入门教程(三)
- Docker 入门教程(三)
- Maven 入门教程(三)
- Lucene入门教程(三)
- 构建maven项目失败解决办法
- emacs修改配置文件路径
- linux下网络排错与查看
- 安规电容类别及作用
- 非真爱,最痛苦
- Grunt入门教程之(三)
- iOS 之UIGraphicsBeginImageContext系列知识
- 设计符合人需求层次模型的商业模式——揭密冰桶挑战背后,不为人知的商业秘密!
- PushbackInputStream简介及用法
- UML建模之时序图(Sequence Diagram)
- CentOS---网络配置详解
- Cocos2d-x之 CCObject
- __cdecl __stdcall区别
- UVA 11853 - Paintball(dfs)