博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
JsDoc应用与配置
阅读量:4938 次
发布时间:2019-06-11

本文共 578 字,大约阅读时间需要 1 分钟。

1. JsDoc相关网址
    google code网址:
    github网址:
 
2. API生成模板,codeview,在 附件中有。
 
3. API生成功具,jsdoc-toolkit,在 附件中有。
 
4. 相应的配置文件可以参考:conf/smaple.conf
    其中几个要点:
    // 源文件
    _: ['  ', '  ']          // 其中每一个文件用一个单引号括起来,可以支持多个文件同时生成。
    d: xxxx              //  该参数配置api文件生成后,存放的目录。
    t: xxxxx             //  该参数配置在API生成时所采用的模板
 
5. 执行命令生成,在附件中,我写了一个BAT文件。
    java -jar jsrun.jar app\run.js -c=conf\sample.conf
    
如果你的jsdoc出现编码问题,中文是乱码的话可以使用-e参数来制定编码,当然编码要和你的js文件格式一致,如果你的js是utf-8格式,则使用:-e=utf-8。如:java -jar jsrun.jar app\run.js -e=gb2312 -c=conf\sample.conf
 
6. 注释编写手册可参考:
 
7.
8. 生成后的效果:
    
 

附件列表

 

转载于:https://www.cnblogs.com/lfire/archive/2012/10/12/2721665.html

你可能感兴趣的文章
如何在makefile中写cd命令
查看>>
redis配置认证密码以及远程访问
查看>>
windons下一些软件的地址
查看>>
numpy ndarray 返回 index 问题
查看>>
leetcode 8. String to Integer (atoi)
查看>>
USACO section1.2 Name That Number
查看>>
Android 用application保存全局变量,关于Android中传递数据的一些讨论
查看>>
[Google Android] RelativeLayout 布局底部的EditText会被弹出的键盘遮挡
查看>>
(随用随总结)Linux下面的特殊权限&不同的文件类型
查看>>
Failed to start component [StandardEngine[Catalina].
查看>>
[VBA]批量新建指定名称的工作表
查看>>
委托与事件的关系
查看>>
固定资产管理系统 概要说明书说明书
查看>>
类的绑定方法
查看>>
2016-5-25授课(3)
查看>>
新增加的元素 相关操作获取不到
查看>>
Zabbix 3.0编译安装
查看>>
json介绍及简单示例
查看>>
h.264 率失真优化
查看>>
【转】拓扑排序入门
查看>>