【问题标题】:Proper way to document a Class in JSDoc在 JSDoc 中记录类的正确方法
【发布时间】:2014-07-01 11:19:12
【问题描述】:

给定

function Just (x) {
    this.some = x;
    this.other = 1;
}

在 JSDoc 中记录此类的最推荐方法是什么? (以xstring)。

【问题讨论】:

  • 它是一个构造函数,而不是一个类。 PS:usejsdoc.orgPPS:展示你最好的尝试,让我们去codereview.SE
  • @zerkms 这两个不是同义词吗?
  • @Todd:从什么角度?从很多人的角度来看——是的。从ECMAScript standard 的角度来看 - 没有。

标签: javascript jsdoc


【解决方案1】:
/**
 * Creates a new Just.
 * @class
 */

来源:http://usejsdoc.org/tags-class.html

【讨论】:

  • 参数呢?会员呢?
  • 是的,xsomevalue 呢?
  • 每个属性里面都应该有自己的jsdoc,你可以随心所欲地声明,并添加额外的标签,如private、protected、overload、final
猜你喜欢
  • 2023-03-14
  • 2013-12-13
  • 2014-08-04
  • 1970-01-01
  • 2012-02-17
  • 1970-01-01
相关资源
最近更新 更多