JSDoc 规范
命 令 名 描 述
@param @argument 指定参数名和说明来描述一个函数参数
@returns 描述函数的返回值
@author 指示代码的作者
@deprecated 指示一个函数已经废弃,而且在将来的代码版本中将彻底删除。要避免使用这段代码
@see 创建一个HTML链接,指向指定类的描述
@version 指定发布版本
@requires 创建一个HTML链接,指向这个类所需的指定类
@throws @exception
描述函数可能抛出的异常的类型
{@link} 创建一个HTML链接,指向指定的类。这与@see很类似,但{@link}能嵌在注释文本中
@fileoverview 这是一个特殊的标记。如果在文件的第一个文档块中使用这个标记,则指定该文档块的余下部分将用来提供这个文件的概述
@class 提供类的有关信息,用在构造函数的文档中
@constructor 明确一个函数是某个类的构造函数
@type 指定函数的返回类型
@extends 指示一个类派生了另一个类。JSDoc通常自己就可以检测出这种信息,不过,在某些情况下则必须使用这个标记
@private 指示一个类或函数是私有的。私有类和函数不会出现在HTML文档中,除非运行JSDoc时提供了--private命令行选项
@final 指示一个值是常量值。要记住JavaScript无法真正保证一个值是常量
@ignore JSDoc忽略有这个标记的函数
原文:
http://robinqu.iteye.com/blog/443435
分享到:
相关推荐
Java JsDoc Toolkit v2.0文档工具下载,可以把javaScript描述信息格式化,开发者只要按JsDoc规范写好注释就可以很方便的导出文档。这是Java版本的,附有JAVA源文件,这款工具也是google 极力推荐的JsDoc输出工具。
JsDoc Toolkit不久前发布了2.3.2版本,主要还是对前版本的修复。 如果你需要使用Ant,JsDoc还有一个Ant插件:JsDoc Toolkit Ant Task 下载JsDoc Toolkit2.3.2:...
入门swagger-jsdoc将经过验证的OpenAPI规范返回为JSON或YAML。 const swaggerJsdoc = require ( 'swagger-jsdoc' ) ;const options = { swaggerDefinition : { openapi : '3.0.0' , info : { title : 'Hello World' ...
JsDoc Toolkit 是一个把js描述格式化成文档的工具。开发者只需按JsDoc的规范写好注释就可以很方便导出文档。它是google 推荐的JsDoc生成工具。
swagger-jsdoc, 在JSDoc上生成 swagger doc swagger记录代码并保持实时和可以重用的OpenAPI ( Swagger ) 规范。 这里规范可以是你的api驱动项目的核心: generate,服务器,客户,测试,以及更多的基于丰富的OpenAPI...
JsDoc Toolkit 是一个把js描述格式化成文档的工具。开发者只需按JsDoc的规范写好注释就可以很方便导出文档。这个JsDoc是Java版本的,用起来方便一些。这也是 google 推荐的 JsDoc 输出工具
JsDoc Toolkit 是一个把js描述格式化成文档的工具。开发者只需按JsDoc的规范写好注释就可以很方便导出文档。这个JsDoc是Java版本的,用起来方便一些。这也是 google 推荐的 JsDoc 输出工具
JsDoc Toolkit 是一个把js描述格式化成文档的工具。开发者只需按JsDoc的规范写好注释就可以很方便导出文档。这个JsDoc是Java版本的,用起来方便一些。这也是 google 推荐的 JsDoc 输出工具
openapi-jsdoc以json格式返回OpenAPI规范。 const openapiJSDoc = require ( 'openapi-jsdoc' ) const api = openapiJSDoc ( { definition : { // info object, see ...
内容索引:JAVA源码,综合应用,JsDoc,文档生成工具 JsDoc Toolkit 是一个文档导出工具,它可以把javaScript描述信息格式化,开发者只要按JsDoc规范写好注释就可以很方便的导出文档。这是Java版本的,附有JAVA源文件,...
Kitjs,(http://xueduany.github.com/KitJs),是我2011年底,离开淘宝UED之后,自己搞起的...所以近期也对原来的所有模块按照jsdoc规范更新了一遍API文档,逐步开源给大家使用。 先放个Kitjs族谱,让大家对于kit有个
JsDoc Toolkit 是一个把js描述格式化成文档的工具。开发者只需按JsDoc的规范写好注释就可以很方便导出文档。这个JsDoc是Java版本的,用起来方便一些。这也是 google 推荐的 JsDoc 输出工具
JSDoc 规范代码注释风格(未实现) Karma 自动化完成单元测试(有问题) Webpack 最终打包整个项目文件(未实现) Yeoman 最后封装成一个项目原型模板(未实现) 用户场景 首次登陆 场景.1: 用户被微信授权后跳转图书导航页...
基于Unist规范的语法树JSDoc 安装 $ npm install @geut/jsdast 用法 const unified = require ( 'unified' ) const { parser } = require ( '@geut/jsdast' ) const tree = unified ( ) . use ( parser ) . parse ...
swagger-jsdoc将经过验证的swagger规范返回为JSON。 在提供程序json中使用以下代码在应用程序根目录中的bootstrap文件夹内的app.js文件中注册adonis-swagger-jsdoc 'adonis-swagger-jsdoc/providers/...
end-utils使用工具函数:import 具体的工具方法 from front-end-utils/+文件夹名称(在api里找,你想用啥,文件夹名称就是啥)注意事项每个工具方法都是独立存在的每个工具方法都不依赖框架文件命名请按照命名规范包...
生成OpenAPI规范和客户端的示例项目 您将在此处找到后端和前端实施。 :warning: 首先启动后端,以便能够构建前端! 该项目简单演示了如何设置Node.js + Express + TypeScript,并添加了一个特殊端点,该端点生成...
typera-openapi-用于typera的OpenAPI生成器 typera-openapi是一种工具,该工具自动为使用进行... /** The JSDoc text is used as a description for object properties */ field : number } const bodyCodec = t . ty
Moye 是 ECOM UI 1.1 规范的一个轻量级实现。 如何使用 前期准备: git、nodejs、grunt-cli 与 edp 获取源码: $ git clone git://github.com/ecomfe/moye.git $ cd moye 安装依赖: $ npm install 生成 API ...