我希望内联评论尽可能短，因为我的经验是超过3或4行的评论往往被掩盖，造成很多不必要的“阅读手册行”。遗留要求我遵守与jsdoc兼容的格式来记录代码。如果要正确记录很多不言而喻的事情，就需要明确声明。实际上每个标签都属于这一类。即使是那些没有的对于工作的开发人员来说通常也是无用的。我的愿景是在代码本身内有一个开发人员实际阅读的快速摘要，但引用一个单独的文件(或者甚至是同一文件中的评论转储，与开发人员工作的地方分开)以进行额外标记，像这样:/***Usedwhenmakinganexampleoftheargument.*@includesomeotherplace*/functionex
我正在尝试找出在JSDOC中将外部类指定为参数/返回的正确语法。所以，例如，我有:importreduxfrom'redux';/***@param{object}state*@return{{module:redux.Store}}*/exportfunctioninitState(state=initialState){store=redux.createStore(theReducer,Immutable.fromJS(state));returnstore;}问题是，如果我在webstorm中使用它，Store上的“GoToDeclaration”会将我带到完全不相关的地方。这
我正在为pixijs库准备externs文件以与闭包编译器一起使用。到目前为止，我遇到的唯一问题是自定义对象参数。这是一个简短的例子:pixi.js来源:/***Setthestyleofthetext**@param[style]{object}Thestyleparameters*@param[style.font='bold20ptArial']{string}Thestyleandsizeofthefont*@param[style.fill='black']{string|number}Acanvasfillstylethatwillbeusedonthetexteg'red
关闭。这个问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提问寻求书籍、工具、软件库等的推荐。您可以编辑问题，以便用事实和引用来回答。关闭4年前。Improvethisquestion我正在为我的JS库寻找文档生成器。我找到JSDuck最全面和最强大的。但我没有看到使用其语法为泛型类和函数定义类型变量的方法。快速浏览流行的JS文档生成器让我觉得它们都没有这样做的能力。这是我正在寻找的伪示例:/***@classMyArray*Myperfectarrayclass.*@typevarT*/MyArray=function().../***@cl
在GoogleClosure中，如果初始化一个特定的Array的@type{Array.}，我能确定GoogleClosure会确认数组内容吗？这是一个小测试用例。在我看来，{Array.}正在偷偷通过{Array.}检查，尽管{string}被相同的检查正确阻止。我对GC有点陌生，这是我的错误吗？我已将其粘贴到GoogleClosureService，并且我只显示了两个预期错误之一(2013年9月12日)。我已经在我的本地jar文件(最新的v20130823)上用ADVANCED_OPTIMIZATIONS和warning_levelVERBOSE对这个进行了双重测试。它看起来仍然像
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注释中引用此类
如何使用jsDoc在JavaScript中记录命名空间？这是我的尝试，对吗？/***Myspecialnamespace**@namemy.namespace*@namespace*/$namespace('my.namespace',/**@lendsmy.namespace**/{/***Foo-doessomethingreallyneat...*@function*/foo:function(){}});澄清一下，上面的用法如下:my.namespace.foo(); 最佳答案 此功能在jsdoc3中可用micmath/js
使用.jsrc文件时，我的服务器/前端文件出现以下错误。它在我的文件顶部抛出一个错误。我该如何抑制它？Unsupportedrule:fixatjs/server.js:1|'usestrict';Unsupportedrule:fixatjs/example.js:1|(function(){这是我的.jscsrc文件//http://jscs.info/rules.html{"requireOperatorBeforeLineBreak":true,"requireCamelCaseOrUpperCaseIdentifiers":"ignoreProperties","maximu
