FED实验室 - 专注WEB端开发和用户体验

Grunt:自动生成API文档(yuidoc)

AUTOMATION 煦涵 10451℃ 0评论

一、配置环境
安装Grunt前,需要安装Node和NPM

二、项目创建

1.创建目录:

$ mkdir grunt_yuidoc

2.新建package.json文件

{
  "name": "grunt_proj",
  "version": "0.0.1",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "Benjamin",
  "license": "BSD",
  "devDependencies": {
    "grunt": "~0.4.2",
	"grunt-contrib-yuidoc": "*"
  }

}

3.新建Gruntfile.js文件

module.exports = function(grunt) {
	grunt.initConfig({
		pkg: grunt.file.readJSON("package.json"),

		yuidoc: {
			compile: {
				"name":"yuidoc_proj",
				"options": {
					paths: "./scripts/",
					outdir: "./docs/"
				}
			}
		}

	});
	grunt.loadNpmTasks("grunt-contrib-yuidoc");

	grunt.registerTask("default",["yuidoc"]);
};

4.Grunt及Grunt插件安装:

@ubuntu:~/websites/grunt_yuidoc$ npm install

此时会生成node_modules文件夹,里面存放已安装的模块

5.新建scripts/animal.js文件

/**
 * [Animal description]
 * @class Animal
 * @constructor
 * @param {[String]} name [动物名称]
 */
function Animal(name) {
	this.name = name;
}

Animal.prototype = {
	constructor: Animal,

	/**
	 * [getName 获取动物名称]
	 * @method geName
	 * @param  {[String]} name [动物名称]
	 * @return {[String]}      [动物名称]
	 */
	getName: function(name) {
		return this.name;
	},

	/**
	 * [setName 设置动物名称]
	 * @method setName
	 * @param {[String]} name [动物名称]
	 */
	setName: function(name){
		this.name = name;
	}
};

5.执行grunt命令,生成docs文件夹,内容如下:

@ubuntu:~/websites/grunt_yuidoc/docs$ ls
api.js  assets  classes  data.json  files  index.html  modules
直接预览index.html可以看到api文档

三、参考链接

http://www.iunbug.com/archives/2012/06/07/296.html

http://www.codebelt.com/javascript/yuidoc-javascript-documentation-tutorial-gruntjs/

http://code.tutsplus.com/tutorials/documenting-javascript-with-yuidoc--net-25324

 

 

下面是「FED实验室」的微信公众号二维码,欢迎扫描关注:

FED实验室

行文不易,如有帮助,欢迎打赏!

赞赏支持or喜欢 (1)or分享 (0)
捐赠共勉
发表我的评论
取消评论

表情

Hi,您需要填写昵称和邮箱!

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址
(1)个小伙伴在吐槽