感谢在这里找到的答案:https://stackoverflow.com/a/19336366/592495我的JavaScript文档组织良好且格式正确。每个namespace都是其中包含的方法的“父级”。但是，导航并不像我希望的那样精细。在通过一个简单的命令(jsdocfile1.jsfile2.js)使用node.js工具编译/渲染后，文档将生成到默认模板中。此默认模板在侧边栏导航中显示我的命名空间，但它不显示每个包含的方法。您可以通过向每个方法添加@class指令来伪造一个方法列表，但正如我们所知，它们并不是真正的类。我希望看到这样的侧边栏导航:MyProject-namesp
我有一个JavaScript函数获取一些参数，包括对象类型。但是，参数的一个属性(对象)将被弃用。我想在文档中指出这种情况，但是我不知道如何将@param标记与@deprecated一起使用。考虑以下示例:/***Thisfunctiondoessomething.**@namemyFunction*@function*@since3.0*@param{function}[onSuccess]successcallback*@param{function}[onFailure]failurecallback*@param{object}[options]optionsforfunc
我有一个如下所示的数组:[{"name":"c917379","email":"jim@bmw.de"},{"name":"c917389","email":"jane@bmw.de"}]它是一个具有多个重复字段的任意长度的数组(为了清楚起见，我将其减少为两个字段)。这将传递到JavaScript方法中。/***@param{?}data*/update:function(data){...}我想知道您将如何在JSDoc中对此进行记录。IE。您将如何记录问号所在的类型？ 最佳答案 在JSDoc给出了一个包含类型MyClass成员的数
我个人不是生成文档的忠实拥护者(我更像是一个“阅读源代码Luke”的人)，但我可以看到此类文档对其他人有何用处。现在，通常他们生成的文档不会影响我，除了一件事:@method。大多数JSDoc注释(例如@param)对于阅读源代码的人来说仍然非常有用，但是@method是100%冗余的:/**@paramnumnumbertoaddfiveto*@methodaddFive*/functionaddFive(num){...所以，我真的很想避免让数百行@method弄乱我们的代码。但是，我的同事认为@method是JSDoc生成器(他使用的是YUI生成器)能够生成类的方法列表所必需的。
在JSDoc可以记录数组内容的确切类型likethis:/**@param{Array.}myClassesAnarrayofMyClassobjects.*/TestClass.protoype.someMethod=function(myClasses){myClasses[0].aMethodOnMyClass();}这使得像WebStorm这样的IDE中的代码完成实际上在[0].之后提供了正确的类型信息。这适用于数组类型，但我有自己的集合类型，我也想在其中使用此功能。问题是我找不到正确的语法(可能是因为还没有)。我希望能够像这样以某种方式声明我的类(class):/***@ty
JSDoc有什么文件吗？两个IntelliJ支持的子集、超集或混合？我使用JSDoc的动机有两个:对于开发人员:IntelliJ可以提供更好的代码完成、代码检查、错误检查等。为了提高运行效率:使用Closurecompiler.对于上面的第1点，使用IntelliJ支持的JSDoc标记对我来说很重要，直到现在解决这个问题主要是一个反复试验的过程。 最佳答案 基于WebStormdocumentation中可用的少量信息，看起来IntelliJIDEA支持整个JSDoc集。文档中唯一的其他说明在viewinginlinedocumen
我一直在尝试使用JSDoc记录以下代码:/***@moduleperson*//***Ahumanbeing.*@class*@param{string}name*/functionPerson(name){this.name=name}Person.prototype=newfunction(){varamount_of_limbs=4;/***Introduceyourself*/this.greet=function(){alert("Hello,mynameis"+this.name+"andIhave"+amount_of_limbs+"limbs");}}但是在生成的JSD
我知道周围有各种风格的JSDoc。而且似乎每个JSDoc解析器的实现都可以识别它自己的一组标记。例如，考虑http://usejsdoc.org/之间的标签差异。和http://www.techrepublic.com/blog/programming-and-development/create-useful-relevant-javascript-documentation-with-jsdoc/451.在这一点上，我只是感到困惑。是否有JSDoc的规范实现或一组广泛认可的核心标签？是否有JSDoc的最佳实现？编辑正如下面的评论中所问，这个问题的原因是我需要解析JSDoc评论以便与
有人用JSDoc记录过BackboneJS代码吗？我在注释Backbone构造时遇到问题，例如:User=Backbone.Model.extend({defaults:{a:1},initialize:function(){//...},doSomething:function(p){//...}});任何建议表示赞赏。谢谢。 最佳答案 如果您谈论的是JSDoc工具包，我认为它以某种方式工作:User=Backbone.Model.extend(/**@lendsUser.prototype*/{/***@classUsercla
我可以声明变量类型吗一使用JSDOC@type注解？/**@typesome.type*/for(letoneofmany){...}诸如PHPDOC注释之类的东西：/**@var\Some\Type$one*/foreach($manyas$one){}看答案是的你可以。您只需要将类型声明移动到括号内的内部，然后才能在您的变量之前：for(/**@type{SomeType}*/constoneofmany){//...}这很好，尽管我通常更喜欢指定类型many反而。例如：/**@type{Number[]}*/constmany=[1,2,3,4];然后是one将自动推断。P.S。：注意我
