我正在尝试找出在JSDOC中将外部类指定为参数/返回的正确语法。所以,例如,我有:importreduxfrom'redux';/***@param{object}state*@return{{module:redux.Store}}*/exportfunctioninitState(state=initialState){store=redux.createStore(theReducer,Immutable.fromJS(state));returnstore;}问题是,如果我在webstorm中使用它,Store上的“GoToDeclaration”会将我带到完全不相关的地方。这
JSDoc@type标签允许指定变量类型,例如/**@type{Number}*/。然而,我也看到了没有花括号的/**@typeNumber*/,它似乎同样有效。UseJSDoc有一个带花括号和不带花括号的例子,但没有讨论区别。GoogleClosureCompiler文档暗示所有声明都必须有大括号,但没有具体说明如果没有大括号会发生什么情况。大括号重要吗?如果是这样,为什么?如果没有,我应该使用它们吗? 最佳答案 我最好的猜测是大括号是为解析器准备的,因为某些类型规范中可以包含空格。例如。具有字符串键和数字值的对象:{Object
我在理解联合中命名空间和模块的用途时遇到了问题。例如,我有一个类Game.utils.Matrix。我想将Game注释为命名空间,将utils注释为模块,将Matrix注释为类:/***@namespaceGame*//***@moduleutils*@memberOfGame*//***Createamatrix*@constructor*/functionMatrix(){}它创建了一个文档,Matrix类的名称路径是Game.utils~Matrix,但是如果我点击Module链接它的名称路径是Module:utils,没有Game命名空间前缀,如果我点击Game链接,它不包含u
在我的VS2015JavaScript应用程序中,我有一个从RESTAPI获取的JSON对象,我使用JSDoc@typedef对其进行了记录。评论:/***@typedef{Object}JSON_Response*@property{Number}id*@property{String}name*@property{JSON_Response_Tag}tag*//***@typedef{Object}JSON_Response_Tag*@property{Number}id*@property{String}color*/当我在关于使用这些JSON对象的方法的JSDoc注释中引用此类
使用.jsrc文件时,我的服务器/前端文件出现以下错误。它在我的文件顶部抛出一个错误。我该如何抑制它?Unsupportedrule:fixatjs/server.js:1|'usestrict';Unsupportedrule:fixatjs/example.js:1|(function(){这是我的.jscsrc文件//http://jscs.info/rules.html{"requireOperatorBeforeLineBreak":true,"requireCamelCaseOrUpperCaseIdentifiers":"ignoreProperties","maximu
Jsdoc在本地安装(npminstalljsdoc)。尝试执行时出现以下错误.\node_modules.bin\jsdoc--debug./lib/JavaScriptSource.js输出:调试:JSDoc3.3.0-dev(2014年6月15日星期日18:39:52GMT)调试:环境信息:{"env":{"conf":{"tags":{"allowUnknownTags":true},"templates":{"monospaceLinks":false,"cleverLinks":false,"默认":{"outputSourceFiles":true}},"source":
我刚开始使用WebStorm和JSDoc来记录我的JavaScript。我仍然没有找到使用某种WebStorm内置功能生成HTML文档的方法。在网上和StackOverflow上搜索了一下,只发现了很多关于JSDoc的语法等问题。我错过了什么?我正在使用WebStorm7.0.3。 最佳答案 从Webstormv8.0.0开始,您只需输入/**即可创建JSDoc注释就在method之前或function声明你要添加的文档,然后按Enter,这将生成一个基本block,其中包含你所有的parameters。已经设置好。有关thisWe
我正在使用documentationjs(它在幕后使用jsdoc)来处理我正在处理的库的文档生成。我的lib是用ES6编写的并且功能齐全,目前生成的文档是lib中所有模块的所有函数的按字母顺序排列的列表。这使得很难找到您要查找的内容。我应该如何使用jsdoc注释,以便将一个文件中的函数组合在文档中?例如,给定以下文件....../***Docsforalpha*/exportconstalpha=(){};/***Docsforbeta*/exportconstbeta=(){};/***Docsforcharlie*/exportconstcharlie=(){};…我应该如何使用j
我有一个正在开发的JavaScript库。我已将它构建成许多文件,并使用模块方法来定义每个“模块”。varns=generateNamespace("me.mycompany.mypackage.MyFile");(function(ns,undefined){//somemodule}(ns));模块是使用命名空间函数动态命名的,这意味着就目前情况而言,自动完成几乎是不可能的(除非Eclipse可以运行我的代码并找出命名空间,否则VisualStudio可以!)。因此我打算为我的项目生成JSdoc,希望如果我将它包含到Eclipse中(以某种方式)Eclipse可以使用它来为我提供内
我对JSDoc很陌生,我正在试用Webstorm,所以我对webstorm也很陌生。一方面,我有一个这样声明的接口(interface):/**@interface*/functionIInterface(){}IInterface.prototype.myMethod=function(){};另一方面,我正在开发一个模块,我在其中实现了这个接口(interface):window.exports.MyImplementation=(function(){"usestrict";/****@constructor*@implements{IInterface}*/functionMy