JSDoc有一个@readonly doclet tag： The @readonly tag indicates that a symbol is intended to be read-only. 例如： /** * The name of the represented principal * @member {string} * @readonly */ this.name = primaryName; 但是,我真正想要传达和记录的是公共消费者应该
如果类成员是从某些选项创建的,那么如何声明它们？ class cls { constructor(options) { Object.assign(this, { arr: [], }, options); this.arr[0] = 1; // <- IDE thinks that arr is an unresolved variable } } 解决方法:为了
我特指的是JavaScript匿名函数,但这可能与其他语言有关.我喜欢在我的脚本中使用JSDoc符号,因为我知道其他人迟早会被黑客攻击.当我有非常复杂的匿名函数时,人们如何记录它以便Eclipse和其他了解JSDoc或JavaDoc符号的IDE获取它？ /** * Blah Blah blah * * @param Object Blah bla
JSdoc在我的nodejs模块上生成了文档. /** Do something */ function doSomething(param1, param2) { // blah blah ... } module.exports.doSomething = doSomething; JSDoc生成的文件在Global范围内生成了注释,我有数百个这样的导出函数. 有没有办法让JSDoc生成按模块文件
使用jsdoc来记录JavaScript模块时,是否可以设置别名方法名称？例如,我有一个像这样的方法： /** * @name MyModule#save */ MyModule.prototype.save = function(...) { ... } 但我的模块有别名方法save(),如cache(),put(),set()等.它们只是方便的方法,因此开发人员可以选择使用的
如何使用JSDoc自动生成构成gulp任务的文件的文档？ 例如,我有一个名为assets的任务文件.我想在文件本身中编写一些简单的描述,并让JSDoc使用gulp自动生成实际的文档. var gulp = require('gulp'); var documentation = require("jsdocs"); /** * A simple task to genera
这就是我实际执行此操作的方式,但在生成文档后,私有方法和属性是不可见的. 我做错了什么？ 顺便说一下,其他一切都很好.我第一次使用文档生成器,我印象非常深刻. /** * Constructor Description * @constructor * @class * @classdesc Something about my class Foo. */ contai
我有一个jsdoc注释的函数,类似于我的代码中的以下内容： /** * Foo function * @param {Object} [options] * @param {String} [options.foo] */ var foo = function (options) { if (!options) options = {}; var foo = options.foo || 'foo'; // ... }; 我的IDE
我正在使用jsdoc记录我的代码,到目前为止很好,我有如下的评论 ... * @property {string} mode - mode of display 'video' - display video or 'audio' - play only the audio. * @property... 它来自html文档之类的 | ... | | |
我希望我的代码,如下所示,可以使用JSDoc(v2.4.0)生成描述对象文字的每个属性的文档,但它不起作用.有谁知道如何使用JSDoc从使用getter / setter的代码生成文档？ /** Enum of days of week. */ var Day = { /** Sunday. */ get Sun() { return 0; }, /** Monday. */
是否可以在Sublime Text或Webstorm中输入JSDoc样式的注释,如下所示： /** * Repeat <tt>str</tt> several times. * @param {string} str The string to repeat. * @param {number} times How many times to repeat the string. * @returns {string} */ 并生成如下函数定义： f
我正在尝试使用JsDoc来记录es6类.无法相信您不能将类作为参数传递(类类型,而不是实例类型). 我一直在尝试但不能让这个简单的代码工作,以便JsDoc不会给我一些警告. 我不能让它工作,除非我为每个类创建一个@typedef,然后手动添加所有自己和继承的成员.甚至不能做混合！ 有没有人成功传
