jjzjj

jsdoc-toolkit

全部标签

javascript - 如何在 JSDoc 中描述解构的对象参数

如果我有一个将对象作为参数的JavaScript函数,我可以像这样使用JSDoc描述对象的预期属性:/***@parambar*@parambar.baz{number}*@parambar.qux{number}*/functionfoo(bar){returnbar.baz+bar.qux;}如果我使用ECMAScript6解构定义我的函数,而根本没有为实际参数对象命名,我该如何描述这些属性?constfoo=({baz,qux})=>baz+qux; 最佳答案 事实证明,JSDoc确实支持通过构成占位符名称进行解构。缺少官方文

javascript - 如何在 JSDOC 中记录对象数组

我有一个以对象数组作为参数的函数,我想像本例中那样使用JSDOC来描述参数(包括数组中对象的属性):/***@param{Array.}filter-arrayoffilterobjects*@param...*/functiondoSomething(filter){}过滤器是这样的:filter=[{id:'session',value:1},{id:'name',value:'john'}]如何在jsdoc3中记录属性id和value? 最佳答案 像这样:/***@param{Object[]}filter-alistofli

javascript - 如何使用 Node.js 在 JSDoc 中将 "import"typedef 从一个文件转换为另一个文件?

假设我有一个名为“File1.js”的文件。在这个文件中,我导出了一个对象的对象,并且我给每个对象一个typedef,就像这样。/***Mytypedefforeachobject.*@typedef{Object}MyObject1*@property{String}usernameYourusername*@property{String}realnameYourrealname.*@property{boolean}isUniqueAreyouuniqueasaperson?*/module.exports={/***PersonOne!*@type{MyObject1}*/my

javascript - AMD + Backbone + JSDoc3 最好的文档方式

我正在寻找记录我的代码的最佳方式,但我没有找到任何东西。我看过其他主题,包括this,但都没有解决我的问题。我有这样的东西:define(['backbone'],function(Backbone){/***@modulemodels/products*//***Productmodel*@class*/varProduct=Backbone.Model.extend({/**@lendsProduct.prototype*//***Somemethod*@param{String}name-Nameofsomething*@return{something}*/someMethod

javascript - JsDoc:如何记录对象可以具有任意(未知)属性但具有特定类型?

这类似于question30360391.我想表达的是,函数的参数是一个普通的JS对象,它可以具有任意属性(未知)名称,但所有属性本身都是具有固定属性的对象。一个例子:函数就是这样/***@param{Descriptor}desc*/functionfoo(desc){//...}一个典型的desc看起来像desc={unknownEntity1:{priority:5;writable:false;},unknownEntity2:{priority:42;writable:true;},unknownEntity3:{priority:9;writable:false;}}我已经

javascript - 使用 JSDoc 记录工厂

为了避免在我的JavaScript代码中使用new,我编写了工厂来创建对象。我尝试了很多组合,给我最满意的结果如下:/***Documentmodule*@moduleapp/document*/(function(){'usestrict';/***Factorythatcreatesadocumentobject.*@aliasmodule:app/document.factory*@return{document}*/functiondocument(){/***Getdocumentid*@methodid*@return{String}*/varid=functionid()

javascript - 引用在 JSDoc 中输入不同的文件而不导入

我在VisualStudioCode中编写JavaScript(ES6)代码并启用了VSCode的类型检查,如VSCodedocs中所述.当引用在另一个文件中定义的类型时(下例中的Track),我收到类似[js]Cannotfindname'Track'的错误在对该类型的JSDoc引用中,除非我导入它。当我导入这种类型时,我从ESLint收到一个错误:[eslint]'Track'isdefinedbutneverused。(没有未使用的变量)我不想禁用ESLint规则。有没有办法仅导入类型以在VSCode中进行类型检查?importTrackfrom"./Track";exportd

javascript - 在 Notepad++ 中使用 jsDoc

我现在使用notepad++进行JavaScript开发。我想知道是否有人成功地将jsDoc与notepad++集成以方便代码注释。我之前使用过Aptana,我相信它已经作为ScriptDoc集成在其中,但Aptana变得非常慢。 最佳答案 可以使用NppExec插件让jsDoc工作。这些步骤非常简单,阅读本文后应该会更加简单。在NPP(我使用的是5.9.3版)中打开插件管理器安装NppExec插件。(Npp重启,我相信)转到插件下的NppExec菜单,选择“执行”菜单选项。一个微小的脚本窗口打开。输入以下NppExec脚本:NPP

user-interface - Walk GUI Toolkit for GO 中的文件选择器组件

在walkGUIToolkit中应该有一个FileChooser组件,但我无法找到它。谁能告诉我正确的类(class)? 最佳答案 根据SDK文档,walk工具包的commondialogs.go提供了一个FileDialog:https://github.com/lxn/walk/blob/master/commondialogs.go(搜索“FileDialog”以找到结构) 关于user-interface-WalkGUIToolkitforGO中的文件选择器组件,我们在Stack

xml - 将对象传递到 Template::Toolkit

我正在编写脚本以将我的Stackoverflow事件提要拉入网页,它看起来像这样:#!/usr/bin/perlusestrict;usewarnings;useXML::Feed;useTemplate;my$stackoverflow_id=1691146;my$stackoverflow_url="http://stackoverflow.com/feeds/user/$stackoverflow_id";my$template=new('STRICT'=>1)ordie"Failedtoloadtemplate:$Template::ERROR\n";my$feed=XML::