Javascript 如何在jsdoc中将模块分配给名称空间?
我们将jsdoc用于一个非常繁重的javascript项目。 为了获得代码文档,我们让jsdoc通过grunt构建html文件 到目前为止,我们使用“memberof”关键字成功地为模块分配了属性和方法,如下所示: 示例Javascript 如何在jsdoc中将模块分配给名称空间?,javascript,namespaces,jsdoc,javascript-namespaces,Javascript,Namespaces,Jsdoc,Javascript Namespaces,我们将jsdoc用于一个非常繁重的javascript项目。 为了获得代码文档,我们让jsdoc通过grunt构建html文件 到目前为止,我们使用“memberof”关键字成功地为模块分配了属性和方法,如下所示: 示例 /** * Short description of this module * * * @module hse-catalog */ jQuery(document).ready(function($) { 'use strict'; /**
/**
* Short description of this module
*
*
* @module hse-catalog
*/
jQuery(document).ready(function($) {
'use strict';
/**
* @namespace catalog
* @memberof module:hse-catalog
*/
catalog = {
selector: {
/* Stuff in here */
},
/**
* Initializes the module.
*
* @memberof module:hse-catalog
*/
init: function() {
// do init
},
/**
* Indicates whether the module is ready to load.
*
* @return {boolean} true or false
* @memberof module:hse-catalog
*/
isReady: function() {
// do stuff
}
/**
* Initializes the catalog page breadcrumb.
* @deprecated out of order
* @memberof module:hse-catalog
*/
initBreadcrumb: function() {
// do stuff
}
};
});
这为我们创建了一个非常好的html文档,其中列出了所有模块。如果我点击其中一个模块,我会看到这个模块的所有属性和方法。到目前为止还不错
但真正的问题是,我们还希望将模块分配给某些名称空间。我们怎么做?jsdoc支持这一点吗?您是否希望您的模块实际出现在jsdoc文档中称为“名称空间”的内容中?如果是,我认为这可能是不可行的。如果您对不是“名称空间”的内容感到满意,那么如果您可以在问题中指定希望文档为您做什么,这将有所帮助。(我之所以问后者,是因为我对一个应用程序使用jsdoc,该应用程序有50多个层次结构中的模块。我不使用名称空间,但我所做的可能无法满足您的要求。)@Louis我希望模块和名称空间之间有一种类似的关系,就像Java中类和包之间的关系一样。在我看来,你认为jsdoc的名称空间类似于Java的包,jsdoc的模块类似于Java的类。实际上,jsdoc的模块与Java包类似,一个模块可以包含一个或多个类。@Louis Ahhh!现在我明白了!谢谢,伙计,这就解决了问题。@Louis,请补充一个答案;-)非常感谢。