javascript - JSDoc 中实例与静态方法名称路径的文档

Question

在记录 javascript 方法时，我知道在名称路径中使用 # 表示实例方法，例如:

function Class() {}

/**
 * Class#method1
 */
Class.prototype.method1 = function () {}

但是，我也看到了 ~ 和 . 的用法。这些是做什么用的？

/**
 * Class~method2
 * Class.method3
 */

还有其他我应该注意的语法吗？

Answer 1

您可以查看变量/方法命名约定的详细信息here .

. 用于表示类方法(也称为静态方法)，而不是实例方法。这意味着在类的实例(用 new 创建的东西)上你不能调用类方法。

例子:

Class.foo = function () {
  // ...
};

var blah = new Class();
blah.foo();  // throws an error

Class.foo();  // actually calls the function

~ 用于表示一个内部方法(也称为私有(private)方法)，它是使用function 在类的方法内部定义的方法。这些类型的方法通常不能从方法外部访问，因此您很少会看到这些方法的文档。

例子:

function Class() {
  // this function is not accessible outside of the constructor
  function inner() {
  }

  // unless we give it some other reference that is visible:
  this.accessInner = inner;
}

blah = new Class();
blah.inner();        // throws an error
Class.inner();       // also throws an error
blah.accessInner();  // will actually call inner