Javascript 如何使用AMD模块和工厂风格的构造函数编写简明的JSDoc?
我试图将JSDoc添加到一个项目中,其中大多数源代码遵循以下准则: 脚本是AMD模块,用于定义类,它们导出构造函数 施工人员实际上是工厂;如果省略了new,它们将返回匿名对象,而不是填充该对象,以避免出现不希望出现的行为。 我想使用JSDoc来记录这一点,但目前要正确处理这一点似乎需要大量冗余:Javascript 如何使用AMD模块和工厂风格的构造函数编写简明的JSDoc?,javascript,jsdoc,Javascript,Jsdoc,我试图将JSDoc添加到一个项目中,其中大多数源代码遵循以下准则: 脚本是AMD模块,用于定义类,它们导出构造函数 施工人员实际上是工厂;如果省略了new,它们将返回匿名对象,而不是填充该对象,以避免出现不希望出现的行为。 我想使用JSDoc来记录这一点,但目前要正确处理这一点似乎需要大量冗余: /** * These are my docs for SomeClass. * @module path/to/some-module */ define( /** @lends mod
/**
* These are my docs for SomeClass.
* @module path/to/some-module
*/
define(
/** @lends module:path/to/some-module */
function () {
/**
* Construct some object.
* @constructor
*/
function SomeClass(a, b, c) {
var somePrivateVariable;
function somePrivateFunction() {}
return {
/** @memberof module:path/to/some-module~SomeClass# */
someMethod: function () {},
/** @memberof module:path/to/some-module~SomeClass# */
someOtherMethod: function () {}
};
}
return SomeClass;
}
);
我想缩短这个。特别是,在所有这些@memberof标记之后的长路径是乏味和嘈杂的,特别是当有很多方法时。@lends也很烦人,因为从人类读者的角度来看,它完全是多余的
有没有更好的方法不用重写或重构代码本身就能做到这一点