是否有可能在一个类(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接受。正确的语法是什么？附言我的一些用例需要多行注释。
感谢在这里找到的答案: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成员的数
