node环境下,jsdoc使用方法简介
来源:互联网 发布:it技术分类 编辑:程序博客网 时间:2024/06/14 06:20
一、用express搭建一个node环境。
二、输入npm install jsdoc@"<=3.3.0",安装jsdoc
三、进入.bin目录下,jsdoc -v检查版本信息,同时确定jsdoc是否安装成功。
四、在.bin文件夹下,新建test.js 文件,输入下面代码保存。
/** * MyClass类 * @class MyClass * @constructor */function MyClass() { /** * a属性 * @property a * @type int **/ var a = 0; /**获得A的值@memberof MyClass@method getA @param returnType {int} 要设置的值@example ele.setReturnType('0000'); **/ function setA(a) { this.a = a; } /**设置A的值@memberof MyClass@method getA @param returnType {int} 要设置的值@example ele.setReturnType('0000'); **/ function getA() { return a; }}然后,jsdoc test.js 运行,看目录下是否生成out文件夹。out文件夹下,即为js的api文档。
点开相应的html,即可看到文档说明
0 0
- node环境下,jsdoc使用方法简介
- jsDoc使用方法
- jsdoc
- jsDoc
- LInux下使用JSDoc生成javaScript文档
- Linux下GCC使用方法简介
- Linux下GCC使用方法简介
- Linux下GCC使用方法简介
- Linux下GCC使用方法简介
- Linux下GCC使用方法简介
- Linux下GCC使用方法简介
- Linux下GCC使用方法简介
- mac环境下升级node
- Node.js简介及安装开发环境
- windows环境下node.js环境搭建
- C#环境下log4net使用方法
- C#环境下log4net使用方法
- 在cygwin环境下编译node.js
- good website
- iOS开发 跳转到指定界面(栈中不存在的界面)
- Android开发-自定义View-AndroidStudio(四)简介动画
- 【Android】Anroid5.0+新控件---酷炫标题栏的简单学习
- DOS命令之断开本机远程连接BAT
- node环境下,jsdoc使用方法简介
- Fresco图片加载框架使用方法完全指南
- 使用easyui dialog 弹出框的一些注意事项
- OFFICE 2007下右键新建OFFICE 2003的快捷方式
- Android Studio 百度地图 230错误 Scode码校验失败应急处理 只看楼主收藏回复
- VGG Convolutional Neural Networks Practical(3)pooling
- 使用 Java 8 语言功能
- 条件概率的逆问题 - 贝叶斯公式
- 监控WINDOWS服务,当服务停止后自动重启服务