一、命令分类
类定义
@class 类型定义
@version 版本信息
@author 作者
@constructor 构造方法
@description 描述
@example 示例
@param
/**
* @name Tabs
* @author Halen
* @class 页签组件
*
* @constructor
* @description 构造函数.
* @param p
*/
Tabs = function(p) {
}
属性定义
@default 默认值
@type 类型
@description 描述
@example 示例
/**
*是否懒加载。
* @default false
* @type Boolean
* @example
* var tabs = new Tabs({lazyLoad:false});
*/
lazyLoad : false,
方法定义
@param 默认值
@returns 类型
@description 描述
@example 示例
/**
* 改变label属性。
* @name AutoComplete#changeLabel
* @function
* @param {String} label 按钮文本
* @example
* var autoComplete = new AutoComplete();
* autoComplete.changeLabel(“new label”);
*/
changeLabel : function(label){
}
事件定义
@event 声明为事件
@param 默认值
@returns 类型
@description 描述
@example 示例
强制定义
@field 字段/属性
@function 方法
@event 事件
@name 名称定义
继承相关
@lends
@augments
@borrows
类型相关
@constant
@private
@static
@public
@inner
综合
@deprecated 已过期
@link 引用
@see 引用
@throws 抛出异常
@since 从哪个版本开始生效
@requires 依赖于其他类定义
二、jsdoc的完整命令介绍
http://code.google.com/p/jsdoc-toolkit/w/list
三、使用jsdoc
单独使用Java命令:
java -jar jsrun.jar app/run.js -a -t=templates/jsdoc todocjs/*.js
整合ant命令:
<target name="build-docs" description="build docs">
<delete dir="${docs.dir}"></delete>
<mkdir dir="${docs.dir}"/>
<java jar="${jsdoc.lib.dir}/jsrun.jar" fork="true">
<arg value="${jsdoc.lib.dir}/app/run.js"/>
<!-- the path of the jsdoc templates-->
<arg value="-t=${jsdoc.builder.dir}/jsdoc"/>
<!-- the source path of the js -->
<arg value="../ui/"/>
<!-- the output path of the generated jsdoc -->
<arg value="-d=${docs.dir}" />
</java>
</target>
四、jsdoc的一些bug
(1)、@default {} 无法正常显示{}
(2)、如果属性和方法名为同一名称,比如name属性和name()方法,无法同时生成同名字的属性和方法,认为是同一个名称,最后只留一个
参考及案例:
http://ui.operamasks.org/website/demos.html
http://code.google.com/p/jsdoc-toolkit/w/list
分享到:
相关推荐
GitHub Action来构建JSDoc文档 这是一个GitHub Action,用于使用构建JavaScript文档。 该操作可以轻松地与其他部署操作结合使用,以将生成的文档发布到。 JSDoc也受支持。 以下示例将为./src目录中的所有源文件生成...
从jsdoc生成markdown api文档。 内容 用法(请参阅此页的下一页) 也许看看? 开发者 用于测试,构建等的框架 软件包grunt-jsdoc2md的API(由grunt-jsdoc2md自行生成) 入门 本指南假定您熟悉npm和grunt的使用。...
该提供了一种在静态网站上生成javascript代码文档的方法。 先决条件 要生成良好的文档,请阅读。 必须安装Node.js和NPM 。 跑步 首先通过执行以下命令来构建项目: npm run build 然后打开docs目录并运行index....
vuepress-jsdoc 这个npm软件包是一个命令行脚本,它扫描您JavaScript,Vue或Typescript源代码,并借助和为vuepress生成markdown文件。如何yarn global add vuepress-jsdocnpm i vuepress-jsdoc -g 例: # search ...
Clerical.js 从jsdoc样式的文档块自动生成README.md文件。 import Clerical from "clerical" ;const clerical = new Clerical ;clerical . saySomething ( ) ; // will output "Something"质量和兼容性 每个构建和...
这个插件使您能够将基于注释的文档生成集成到您的Grunt构建中。 生成您的文档 安装 这个插件要求Grunt >=0.4.0 如果您以前从未使用过 ,请务必查看《指南》,因为它说明了如何创建以及安装和使用Grunt插件。 熟悉...
目标: 生成存根 YAML 文档模板 从 JSDoc 构建文档网页 lint 现有文件**在 1.0、1.1、1.2 和 1.3 之间发生了一些重大变化。 这是一个纯粹的 Node.js 工具。 如果您正在寻找 Grunt 任务,您可以在找到它。 与的合作...
jsdoc-tsimport-plugin 一个JSDoc插件,用于支持Typescript导入语法。 它是什么? VSCode和WebStorm不支持JSDoc typedef... 只需在您的文档注释中使用typescript样式的导入,然后在您构建jsdocs时该插件就会翻译
握手开发人员文档站点 ... 这是GitHub Pages托管的网站。... 构建jsdoc: ./bin/build-docs 跑步 要在本地查看站点,请首先执行build命令,然后从项目的/build目录运行一个简单的http服务器: $ cd build Python2:
ramda.github.io 要生成网站所需的各种文件,请运行以下命令...为了构建jsdoc,需要节点6或更高版本。 如果您使用 ,只需运行: nvm install && nvm use 建筑文档 要重建页面: npm run jsdoc 建筑风格 使用包
” 在已安装的 jsdoc run.js 文件中。 注意:如果您从 RubyGems 安装它,它将无法工作。 要安装 gem,您应该在本地构建它: $ gem build sc_docs.gemspec 然后安装它: $ gem install sc-docs-0.0.3.gem 使用...
YDocYDoc 是一个优雅的文档站构建...: 在页面中引入 js 与 css 文件: 根据代码注释生成文档,基于 jsdoc: 自动替你在网页中所有的中文字和半形的英文、数字、符号之间插入空白(盘古之白)more...主题ydoc-theme-demoyd
文档构建当前仅适用于Mac或Linux文件系统。 链接Enact和相关库 Enact和其他相关库的源副本被放置在raw/目录中。 如果需要链接本地副本,请将其链接到该目录。 例如: ln -s ~ /enact raw/enact ln -s ~ /cli raw/...
该项目的文档是使用sphinx-js构建的。 文档源文件可以在doc目录中找到。 构建文档需要安装sphinx-js 。 sphinx-js需要jsdoc ,可以通过运行安装 npm ci 在doc目录中。 之后,可以使用构建文档 make html 之后,可以...
dotpath-编译 基于点路径的 JavaScript 对象模板编译器。 特征 扩展点路径模板变量 灵活的继承机制 用法 ...npm run jsdoc - 构建 jsdoc npm run dev - 连续运行测试 执照 麻省理工学院许可证 (MIT)
xform-js JavaScript 线性代数库 文档: : 示例: : xform-js 是一个 JavaScript 线性代数库。 它支持 3D 图形中使用的数学以及任何...没有生产依赖项,开发依赖项是用于缩小的 uglify-js 和用于构建文档的 jsdoc。
《编写可维护的JavaScript》向开发人员阐述了如何在团队开发中编写具备高可维护性的JavaScript代码,书中详细说明了作为团队一分子,应该怎么写JavaScript。本书内容涵盖了编码风格、编程技巧、自动化、测试等几方面...
《编写可维护的JavaScript》向开发人员阐述了如何在团队开发中编写具备高可维护性的JavaScript代码,书中详细说明了作为团队一分子,应该怎么写JavaScript。本书内容涵盖了编码风格、编程技巧、自动化、测试等几方面...
CARTO.js 4 CARTO.js是一个JavaScript库,用于创建利用的功能的... 文献资料 API参考运行npm run docs以从jsdoc批注构建API参考文档。 任务完成后,您可以访问docs/public/index.html来检查参考 一般文件您也可以在此仓
Undercut已从JavaScript库开始,用于懒惰的数据处理和构建管道。 它还提供了各种语言实用程序,CLI等。 目标是有一天成为标准图书馆。 该代码是通用代码,可在Node /浏览器/微波中使用。 基于现有的JS协议和语言...