jjzjj

javascript - 让 jsdoc 和 Crockford 的设计模式相处融洽

我正在使用DouglasCrockford的designpattern实现私有(private)、特权和公共(public)方法。它基本上看起来像这样(使用RequireJS):define(function(){returnfunction(){varthat={},_init=function(){//"constructor"},_privateFn=function(){return42;};that.publicFn=function(){return2*_privateFn();};_init(arguments);returnthat;};});但是,我无法获取jsdoc

javascript - 关于使用 jsDoc 记录嵌套数组和对象数据的问题

如何使用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

javascript - 在 typescript 中为泛型函数编写 JSdoc

我用以下代码提炼出了我的问题的本质:fullsource我有基类,派生类,Derived2:classBase{staticgettype(){return'Base';}}classDerivedextendsBase{}classDerived2extendsBase{}现在我有了变量t,它可以是Derived或Derived2的一个实例。它也可以在运行时多次更改。/**@type{Base}*/vart=newDerived();//orvart=newDerived2();我有一个函数检查t是否是传递类的实例,如果它是传递类的实例则返回t,否则返回undefined。/***@

javascript - _以 "revealing module pattern"样式编写的 JSDoc'ing Javascript 文件的最佳实践?

关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我的大多数Javascript函数都相对简单,并且需要它们的副作用:我使用jQuery来操作DOM或进行Ajax调用。我更喜欢以“揭示模块模式”的风格编写我的函数。我justdiscoveredJSDoc-注释Javascript文件有一个好处:在annotations的帮助下,Eclipse的JS开发工具可以解析我的JS文件和filltheEclipseOutlineView(否则将为空

javascript - 如何在 JSDOC 的 'group' 中显示 Javascript 方法?

是否有可能在一个类(AMD/RequireJS模块)中“分组”函数?我的类有时有20多个函数,它们实际上属于特定的“接口(interface)实现”,有时它们只需要分组以提高可读性。我检查了可用的jsDoc标签,但它们似乎都没有提供这个,在Doxygen中有很多标签......有什么想法吗? 最佳答案 这是一种方法,您的模块形状可能非常好,但这适用于类和模块:/***@modulefoobar**@memberofmodule:foobar*@param{string}arganargument**/functionone(arg)

javascript - 使用 jsdoc-toolkit 在命名空间中记录带有原型(prototype)的 javascript 类

我非常努力地使用jsdoc-toolkit以下面的格式记录代码。在我看来,我使用的标签应该会产生所需的结果,但事实并非如此。相反,它警告Class未记录(因为它仅在闭包内定义)并且不在命名空间成员列表中包含Class。如果可能的话,我想在不使用@name标记的情况下记录这一点。谁能帮忙?/***@namespaceTheoriginalnamespace*/varnamespace=function(){//private/***@private*/function_privateMethod(){};/***Thisisthedetailabouttheconstructor*@cl

javascript - 如何在 NetBeans 的 JSDoc 注释中转义 @ 符号

我在API中有一个简单的方法,它允许使用JSONPath搜索对象。由于它的语法对初级开发人员来说非常陌生,我决定在JSDoc注释中提供一些示例。然而,这里有问题,-@符号被视为新jsdoc标签的开始,因此描述已损坏。问题:如何制作NetBeans(或一般的jsdoc)忽略@在特定代码块内签名?最好在@example内block。因此这段代码将在工具提示中显示为未修改:$..book[?(@.price此外,@example,,-不要帮忙。HTML实体@转换为@在工具提示中,但是它在代码本身($..book[?(@.price)中看起来不可读并且它只在主jsdoc文本中工

javascript - Intellisense 不适用于 Visual Studio Code 中的导入

当使用javascript(es2015)导入时,Intellisense似乎已损坏。当我在同一个文件中工作时,VSC会使用正确的JSDoc信息自动建议对象中的方法。但是,当在另一个文件中导入类时,Intellisense似乎完全被破坏了(david.david,wtf?)。我是否需要调整VisualStudioCode中的任何设置才能使其正常工作?我尝试将我的jsconfig文件调整为es2015imports和es6as但这没有用。我的jsconfig.json:{"compilerOptions":{"module":"es6"}} 最佳答案

javascript - document.getElementById ('myID' 的 JSDoc 类型和 jQuery 元素是什么?

我正在尝试使用JSDoc语法记录我的函数。/****MyDescription**@param{JQuery|???}input*@returns{JQuery}*/functionfoo(input){return$('selector');}上述函数接受一个参数,该参数可以是JQuery对象,也可以是document.getElementById返回的元素。getElementById的返回值的有效JSDoc类型是什么?例如,以下都是有效的:foo($('#input'));foo(document.getElementById('input'));另外,以后我在哪里可以找到它?

javascript - Google Closure 编译器 100% 输入

关于google闭包编译器,我怎样才能使我的应用程序100%类型化?我已经用jsdoc注释标记了所有内容。甚至有可能获得100吗?我在64.6% 最佳答案 有可能达到100%。我自己的项目是100%打字的。闭包编译器可以输出关于未知类型表达式的警告。不幸的是,没有命令行选项可以启用此功能。您必须修改源代码才能启用它:下载当前资源:gitclonehttps://code.google.com/p/closure-compiler/编辑src/com/google/javascript/jscomp/CompilerOptions.j