如何使用 yuidoc 记录命名空间

How to document a namespace using yuidoc?

本文关键字：命名空间 记录 yuidoc 何使用      更新时间：2023-09-26

YUIDoc 似乎没有为我的命名空间生成任何文档。 此项目使用揭示模块设计模式

/*
 * Example namespace.
 *
 * @namespace MY_NAMESPACE
 */
var MY_NAMESPACE = (function() {
  /**
   * @property privateProperty1
   * @type {Number}
   * @private
   */
  var privateProperty1 = 1;
  /**
   * Logs the method name to the console.
   * @method privateMethod1
   * @private
   */
  var privateMethod1 = function() {
    console.log('In privateMethod1');
  };
  return {
    /**
     * @property publicProperty1
     * @type {Number}
     */
    publicProperty1: 2,
    /**
     * Logs a simple message to the console.
     *
     * @method publicMethod1
     * @param {String} aString A string to log. 
     */
    publicMethod1: function(aString) {
      console.log('In publicMethod1 and was passed: ' + aString);
    }
  }
})();
如果要

按如下方式使用@namespace，@namespace需要包含@class，但您可能希望使用@class而不是@namespace。

/**
* Example namespace.
* @namespace MY_NAMESPACE
*/
/**
* Example class.
* @class MyClass
*/
相关文章：