如何使用jsdoc格式化嵌套数组和对象？这是我最好的猜测:an_obj={username1:[{param1:"value1-1-1",param2:"value1-1-2",optional_nested:"1-1--2"},{param1:"value1-2-1",param2:"value1-2-2"},],username2:[{param1:"value2-1-1",param2:"value2-1-2"},{param1:"value2-2-1",param2:"value2-2-2",optional_nested:"2-2--2"}]}}/***Afunctionde
我用以下代码提炼出了我的问题的本质:fullsource我有基类，派生类，Derived2:classBase{staticgettype(){return'Base';}}classDerivedextendsBase{}classDerived2extendsBase{}现在我有了变量t，它可以是Derived或Derived2的一个实例。它也可以在运行时多次更改。/**@type{Base}*/vart=newDerived();//orvart=newDerived2();我有一个函数检查t是否是传递类的实例，如果它是传递类的实例则返回t，否则返回undefined。/***@
关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我的大多数Javascript函数都相对简单，并且需要它们的副作用:我使用jQuery来操作DOM或进行Ajax调用。我更喜欢以“揭示模块模式”的风格编写我的函数。我justdiscoveredJSDoc-注释Javascript文件有一个好处:在annotations的帮助下，Eclipse的JS开发工具可以解析我的JS文件和filltheEclipseOutlineView(否则将为空
是否有可能在一个类(AMD/RequireJS模块)中“分组”函数？我的类有时有20多个函数，它们实际上属于特定的“接口(interface)实现”，有时它们只需要分组以提高可读性。我检查了可用的jsDoc标签，但它们似乎都没有提供这个，在Doxygen中有很多标签......有什么想法吗？ 最佳答案 这是一种方法，您的模块形状可能非常好，但这适用于类和模块:/***@modulefoobar**@memberofmodule:foobar*@param{string}arganargument**/functionone(arg)
我非常努力地使用jsdoc-toolkit以下面的格式记录代码。在我看来，我使用的标签应该会产生所需的结果，但事实并非如此。相反，它警告Class未记录(因为它仅在闭包内定义)并且不在命名空间成员列表中包含Class。如果可能的话，我想在不使用@name标记的情况下记录这一点。谁能帮忙？/***@namespaceTheoriginalnamespace*/varnamespace=function(){//private/***@private*/function_privateMethod(){};/***Thisisthedetailabouttheconstructor*@cl
我在API中有一个简单的方法，它允许使用JSONPath搜索对象。由于它的语法对初级开发人员来说非常陌生，我决定在JSDoc注释中提供一些示例。然而，这里有问题，-@符号被视为新jsdoc标签的开始，因此描述已损坏。问题:如何制作NetBeans(或一般的jsdoc)忽略@在特定代码块内签名？最好在@example内block。因此这段代码将在工具提示中显示为未修改:$..book[?(@.price此外，@example,,-不要帮忙。HTML实体@转换为@在工具提示中，但是它在代码本身($..book[?(@.price)中看起来不可读并且它只在主jsdoc文本中工
我正在尝试使用JSDoc语法记录我的函数。/****MyDescription**@param{JQuery|???}input*@returns{JQuery}*/functionfoo(input){return$('selector');}上述函数接受一个参数，该参数可以是JQuery对象，也可以是document.getElementById返回的元素。getElementById的返回值的有效JSDoc类型是什么？例如，以下都是有效的:foo($('#input'));foo(document.getElementById('input'));另外，以后我在哪里可以找到它？
我正在使用JSDoc风格编写一些代码注释，想知道*=在@returns{function(*=):*}中意味着什么，它由WebStorm生成。我尝试搜索JSDocwiki和usejsdoc.org但没有结果。下面是我的代码:/***Getrecorddatalistenergenerator.*@param{Function}createProps*@returns{function(*=):*}//**generatedbywebstorm***/exportfunctiongetRecordCustomDataListener(createProps){return(callbac
我有一个字符串数组，但我不知道如何用JSDoc记录它。/**@class*/functionPostbackList(){/**@type{int}@default*/this.TypeID=0;/**@type{PostbackList.Field[]}*/this.Fields=newArray();/**!!Issuehere!!@type{string[][]}*/this.Values=null;}这会导致错误。Invalidtypeexpression"string[][]":Expected"!","?"or"|"but"["found.而且我不知道是否应该将?放在类型前
对于这样的函数...functionexample(){varX=100;...varY='abc';...returnZ;}我需要解释一些局部变量的用途。添加这样的描述...functionexample(){/***@description-NeedtoexplainthepurposeofXhere.*/varX=100;.../***@description-NeedtoexplainthepurposeofYhere.*/varY='abc';...returnZ;}...似乎没有被JSDocv3.4.0接受。正确的语法是什么？附言我的一些用例需要多行注释。
