jsdoc

7热度

1回答

为了避免在我的JavaScript代码中使用new，我编写了工厂来创建对象。我已经尝试了多种组合，并且给了我最满意的结果之一是： /** * Document module * @module app/document */ (function() { 'use strict'; /** * Factory that creates a document

7热度

1回答

从JSDoc生成Swagger YAML？

我有一个JSDoc完整记录的大型JS API，并且我构建了一个基于REST的服务来使API在网络上可用。我手动构建了YAML Swagger规范的初始版本，但问题是它快速与JS API不同步，因为它仍在不断发展，特别是在涉及的对象的属性中。我想要做的是直接从JSDoc注释中自动生成Swagger YAML，至少是它的数据定义部分。有什么工具可以帮助我实现自动化吗？

2热度

1回答

JSDoc正确地记录路由节点模块

我是新手撰写文档，并希望学习如何正确地做到这一点。我有一个节点REST API，我希望记录。这个API由很多模块组成，看起来像这样： /** @module Rewards */ module.exports = function (express, sequelize, router) { router.route('/action_plan'); var DataTyp

2热度

1回答

ES6迭代器的JSDoc类型名称

我有一个JavaScript方法需要一个迭代器，即遵循the es6 iterable protocol的任何对象。我想在它的JSDoc中注释这个。我如何参考'可迭代'类型？ /** * @param {__WHAT_GOES_HERE__?} iterable */ function consume(iterable) { ... } 我可以写出来的JSDoc整个协议，但这样做有点令人

2热度

1回答

Jshint/PhpStorm： “未解决的变量” 使用jQuery的.data（）时

Phpstorm不断告诉我，我有一个未定义的变量input.connectto HTML： <div class="b-showColorinList" data-connectto="123456" data-othervalue="Lorem Ipsum">... JS： $(document).on('click', '.b-showColorinList', function() {

17热度

1回答

jsdoc适当的方式来记录socket.on（“事件”，函数（）{}）和路由处理器

如何使用它有以下形式（单个文件）jsdoc // api.js exports.addSocketEvents = function(socket) { /** * This will do that and ... * @param {Object} data Some data * @param {string} data.bla Something

4热度

1回答

如何在JSDOC中记录一个对象数组

我有一个以对象数组为参数的函数，并且希望使用JSDOC来描述参数（包括数组中的对象的属性），如下例所示： /** * @param {Array.<Object>} filter - array of filter objects * @param ... */ function doSomething(filter) { } ，其中过滤器是这样的： filter = [

2热度

1回答

如何使用jsdoc记录require-js AMD模块？

经过多天令人沮丧的jsDoc实验，似乎require-js模块（AMD）的文档存在其问题。首先：你不能标记您的模块类： define([ "dcl/dcl", ], function (dcl) { /** * @class BaseClass * See {@tutorial getting-started} */ var Base

0热度

2回答

如何存根TypeScript函数注释？

我正在运行VS2013，我刚开始使用TypeScript。我安装了Web Essentials 2013.5和DocStubJs。目前，当我正在编写javascript时，我使用由DocStubJs自动创建的C＃-ish功能注释：我这样做主要是因为DocStubJs为我省略了评论。它（我假设它是DocStubJS这样做的）甚至可以在TypeScript中工作，并且我刚开始使用它，因为它很熟悉，

1热度

1回答

带节点的jsdoc生成空的index.html

我使用以下命令从javascript文件生成html。 $> jsdoc --debug jquery.js $> open out/index.html 输出命令 DEBUG: JSDoc 3.3.2 (Sat, 13 Jun 2015 22:20:28 GMT) DEBUG: Environment info: {"env":{"conf":{"tags":{"allowUnknown