我似乎找不到这方面的例子。但是我有一个字符串double组(表格单元格数据)，我想在我的JSDoc中记录它。编译器似乎不喜欢这样:/***@param{cells:[[String]]}tableData*/对此并没有什么特别好说的:/***@param{cells:String[][]}tableData*/ 最佳答案 这个怎么样:/***@param{Object>}tableData*/引用:http://wiki.servoy.com/display/public/DOCS/Annotating+JavaScript+usi
我认为React组件的JSDoc注释可能如下所示:/***Mycomponent...**@namespaceMyComponent*@memberofapp.components*/app.components.MyComponent=React.createClass({})但是如果我使用ES6，它应该是什么样子呢？/***Mycomponent...**@namespaceMyComponent*@memberof??*/classMyComponentextendsComponent{/***PropTypes*@param{string}element*/staticprop
如何记录作为参数传递的构造函数(函数)？示例:/**@class*/functionA(){}/***@param{Function}aConstructor*/functioncreateA(aClass){returnnewaClass();}如您所见，我可以指定它是一个函数。但是，我无法指定该函数将创建哪个对象。有什么方法可以记录下来吗？谢谢。 最佳答案 Google及其闭包建议使用{function(new:type)}作为类型描述。我假设，一个人可以使用这样的东西(我在AMD上使用它):/**@param{function
如何记录在函数参数中解构的函数参数？/***Functiondeconstructsargumentanddostuff.*@param{}***whatshouldidohere?****/functionsomeFunction({key1,key2,key3}){//dofunctionstuffs} 最佳答案 来自@paramwikipage:Ifaparameterisdestructuredwithoutanexplicitname,youcangivetheobjectanappropriateoneanddocume
当使用typescript定义React组件时，我们可以这样写:classSomeComponentextendsReact.Component{//...}有没有办法使用jsdocannotations做同样的事情？并对Prop进行类型检查。 最佳答案 我更喜欢以下形式(es2015+@types/react):/***@typedef{object}Props*@prop{string}className*@prop{number}numberProp**@extends{Component}*/exportdefaultcla
假设我有一些对象，使用jsdoc3评论它的方法是什么？/***Testobject*@namespacetest*/vartest={/***Somedefaults*@memberOftest*/defaults:{'test1':1,'test2':2},/***Somthingelse*@memberOftest*/deep:{/***Someoption*@memberOf{test.deep}*/option:{},/***Somemethod*@memberOftest.deep*/method:{},/***Someoption*@memberOf{test.deep.e
我想使用jsdoc模块从一些源代码中提取文档条目。我已经安装了jsdoc模块，我可以在命令行中使用jsdoc。但是当我在我的代码中require("jsdoc")时，nodejs会抛出一个错误，提示Cannotfindmodule'jsdoc'。我有nodejsv0.8.25和JSDoc3.3.0-alpha2。它在本地和全局安装。我可以使用jsdoc命令，我的node_modules文件夹中有jsdoc。我看不出问题出在哪里。除了如何在命令行界面中使用它或如何记录js源代码之外，我在哪里可以找到有关jsdoc的文档。我想要一些API文档。 最佳答案
我有一个JavaScript对象，它引入了一些公共(public)方法，我想使用JSDoc来记录它们。在源文件中，我以合理的顺序对这些函数进行了分组和排序，但是在生成JSDoc之后，我按字母顺序接收了所有这些函数，这没有多大意义。有什么办法可以保持输出的顺序吗？我找不到任何答案，但我也找不到这是不可能的。 最佳答案 简短的回答:在您的conf.json文件中，添加"sort":false的opts元素，其中sort标记JSDoc是否应使用字母排序。假设您正在使用conf.json文件来指定您的JSDOC配置选项:jsdoc-cpat
有没有一种方法可以避免为@property和@param键入两行单独的内容，如示例所示，在构造函数中参数和属性的名称相同。/***Classforrepresentingapointin2Dspace.*@property{number}xThexcoordinateofthispoint.*@property{number}yTheycoordinateofthispoint.*@constructor*@param{number}xThexcoordinateofthispoint.*@param{number}yTheycoordinateofthispoint.*@return
在jsDoc中，我可以像这样指定我的数组参数和成员:/***@constructor*@param{Array.}myArray*/functionsomeFunction(myArray){this.firstArray=myArray;/**@member{Array.}*/this.secondArray=[];}还有没有办法指定这些数组的length，或者minLength和maxLength？ 最佳答案 我想您是在问是否可以在类型表达式中包含最小/最大长度(例如，Array.)。简而言之，答案是否定的。您需要在每个数组的描
