前提环境
生成api文档的程序是基于nodejs编写的,因此需安装nodejs参看这里
安装
npm -g install yuidocjs
使用
/**
* This is the description for my class.
*
* @class MyClass
* @constructor
*/
上面注释为yuidoc提供的文档格式,下面为coffeescript的文档格式。 按照下面的格式即可使用yuidoc生产帮助文档
###*
# This is the description for my class.
#
# @class MyClass
# @constructor
###
生成
# 先进入coffeescript源码所在的文件夹
yuidoc --syntaxtype coffee -e .coffee .
生成的文档类似于yuidoc api