1.0.0 • Published 8 years ago

codoc v1.0.0

Weekly downloads
2
License
ISC
Repository
github
Last release
8 years ago

webminify

codoc根据代码注释生成文档及tsd的工具

  1. 执行npm install codoc -g安装
  2. 在指定目录创建codoc.json文件并按照下述配置规范进行配置
  3. 打开控制台并切换至2所示的目录执行codoc命令即可

codoc.json配置规范

//配置示例
{
	"files": ["flyingon.js"],   //包含注释的源文件列表
	"doc": "../doc",            //生成文档的目录(注:每次生成前会清空目录)
	"tsd": "flyingon.d.ts"      //tsd文件路径
}