javascript - 使用 JSDoc 记录成员函数

标签 javascript jsdoc

我有这样的东西:

/**
Diese Klasse bla bla...
@constructor 
**/
my.namespace.ClassA = function(type)
{
   /**
   This function does something
   **/
   this.doSomething = function(param){
   }
}

该类将列在生成的文档中。该功能不会。有没有办法告诉 JSDoc (3) 这是 ClassA 类的成员函数?

最佳答案

试试这个!

/**
  * Diese Klasse bla bla...
  * @constructor 
*/
my.namespace.ClassA = function(type)
{
   /**
    * This function does something
    * @function doSomething
    * @memberOf my.namespace.ClassA#
   */
   this.doSomething = function(param){
   };
};

JSDoc 在这方面似乎很笨拙:/关键是要同时指定 memberof 和函数名称。 See also .

关于javascript - 使用 JSDoc 记录成员函数,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/18958490/

相关文章:

javascript - NodeJS循环遍历字符串并获得准确的输出

angular - 如何在 Visual Studio Code 中查看 JSCode 生成的文档?

visual-studio-code - JSDoc @typedef 未在其他文件中使用

javascript - 通过 javascript 按钮传递多个元素更改

javascript - 创建接受多个参数的函数

javascript - 如何记录 (jsduck/jsdoc) cucumber.js 步骤定义?

javascript - 如何使用 JSDoc 记录符号索引签名以符合 typescript ?

javascript - JSDoc:类型 'value' 上不存在属性 'EventTarget'

javascript - 使用 WebRTC 在浏览器之间传输 JSON

javascript - 是否有与 .NET HttpWebRequest.ClientCertificates 等效的 Javascript?