草庐IT

javascript - 来自 jsdoc 的错误消息 "There are no input files to process"

Jsdoc在本地安装(npminstalljsdoc)。尝试执行时出现以下错误.\node_modules.bin\jsdoc--debug./lib/JavaScriptSource.js输出:调试:JSDoc3.3.0-dev(2014年6月15日星期日18:39:52GMT)调试:环境信息:{"env":{"conf":{"tags":{"allowUnknownTags":true},"templates":{"monospaceLinks":false,"cleverLinks":false,"默认":{"outputSourceFiles":true}},"source":

javascript - WebStorm:如何生成 JSDoc 文档

我刚开始使用WebStorm和JSDoc来记录我的JavaScript。我仍然没有找到使用某种WebStorm内置功能生成HTML文档的方法。在网上和StackOverflow上搜索了一下,只发现了很多关于JSDoc的语法等问题。我错过了什么?我正在使用WebStorm7.0.3。 最佳答案 从Webstormv8.0.0开始,您只需输入/**即可创建JSDoc注释就在method之前或function声明你要添加的文档,然后按Enter,这将生成一个基本block,其中包含你所有的parameters。已经设置好。有关thisWe

javascript - JSDoc 生成文档中的分组函数

我正在使用documentationjs(它在幕后使用jsdoc)来处理我正在处理的库的文档生成。我的lib是用ES6编写的并且功能齐全,目前生成的文档是lib中所有模块的所有函数的按字母顺序排列的列表。这使得很难找到您要查找的内容。我应该如何使用jsdoc注释,以便将一个文件中的函数组合在文档中?例如,给定以下文件....../***Docsforalpha*/exportconstalpha=(){};/***Docsforbeta*/exportconstbeta=(){};/***Docsforcharlie*/exportconstcharlie=(){};…我应该如何使用j

javascript - 你如何在 Eclipse 中附加 JSdoc 以便我可以自动完成个人图书馆

我有一个正在开发的JavaScript库。我已将它构建成许多文件,并使用模块方法来定义每个“模块”。varns=generateNamespace("me.mycompany.mypackage.MyFile");(function(ns,undefined){//somemodule}(ns));模块是使用命名空间函数动态命名的,这意味着就目前情况而言,自动完成几乎是不可能的(除非Eclipse可以运行我的代码并找出命名空间,否则VisualStudio可以!)。因此我打算为我的项目生成JSdoc,希望如果我将它包含到Eclipse中(以某种方式)Eclipse可以使用它来为我提供内

javascript - Webstorm接口(interface)实现警告使用JSDoc

我对JSDoc很陌生,我正在试用Webstorm,所以我对webstorm也很陌生。一方面,我有一个这样声明的接口(interface):/**@interface*/functionIInterface(){}IInterface.prototype.myMethod=function(){};另一方面,我正在开发一个模块,我在其中实现了这个接口(interface):window.exports.MyImplementation=(function(){"usestrict";/****@constructor*@implements{IInterface}*/functionMy

javascript - 如何在 JSDoc 中记录字符串 double 组?

我似乎找不到这方面的例子。但是我有一个字符串double组(表格单元格数据),我想在我的JSDoc中记录它。编译器似乎不喜欢这样:/***@param{cells:[[String]]}tableData*/对此并没有什么特别好说的:/***@param{cells:String[][]}tableData*/ 最佳答案 这个怎么样:/***@param{Object>}tableData*/引用:http://wiki.servoy.com/display/public/DOCS/Annotating+JavaScript+usi

javascript - ES6 react 组件的 JSDoc

我认为React组件的JSDoc注释可能如下所示:/***Mycomponent...**@namespaceMyComponent*@memberofapp.components*/app.components.MyComponent=React.createClass({})但是如果我使用ES6,它应该是什么样子呢?/***Mycomponent...**@namespaceMyComponent*@memberof??*/classMyComponentextendsComponent{/***PropTypes*@param{string}element*/staticprop

javascript - 如何记录具有已知参数类型的可变长度的参数列表?

相关:Correctwaytodocumentopen-endedargumentfunctionsinJSDoc我有一个函数,它通过访问arguments变量接受多个数组:/***@paramoptionsAnobjectcontainingoptions*@param[options.bind]blablabla(optional)*/functionmodify_function(options){for(vari=1;i现在,我知道除了options之外的每个参数都是一个包含值得记录的值的数组:[search_term,replacement,options]我不考虑将(冗长的

javascript - JSDoc 3 文档构造函数/类参数

如何记录作为参数传递的构造函数(函数)?示例:/**@class*/functionA(){}/***@param{Function}aConstructor*/functioncreateA(aClass){returnnewaClass();}如您所见,我可以指定它是一个函数。但是,我无法指定该函数将创建哪个对象。有什么方法可以记录下来吗?谢谢。 最佳答案 Google及其闭包建议使用{function(new:type)}作为类型描述。我假设,一个人可以使用这样的东西(我在AMD上使用它):/**@param{function

javascript - 如何使用 JsDoc 记录解构的参数

如何记录在函数参数中解构的函数参数?/***Functiondeconstructsargumentanddostuff.*@param{}***whatshouldidohere?****/functionsomeFunction({key1,key2,key3}){//dofunctionstuffs} 最佳答案 来自@paramwikipage:Ifaparameterisdestructuredwithoutanexplicitname,youcangivetheobjectanappropriateoneanddocume