为什么“会员不能有@private JsDoc”？

Question

我正在使用 Google Closure Tools 中的 gjslint 工具清理我的代码。它正在报告以下错误：

Line 15, E:0222: Member "this._dictionary" must not have @private JsDoc

这是代码：

/**
 * Stacker class.
 * @constructor
 * @param {frankenstein.app.Dictionary} dictionary input dictionary for stacking.
 */
frankenstein.app.Stacker = function(dictionary) {
  /** @private */ this._dictionary = dictionary;
};

有人可以解释为什么 this._dictionary 不能有@private JsDoc 吗？谢谢！

Answer 1

Closure Linter 旨在强制执行 Google JavaScript Style Guide。 JSDoc标签@private记录如下：

与方法或属性名称上的尾随下划线结合使用，表示该成员是私有的。随着工具更新以强制执行@private，尾随下划线最终可能会被弃用。

从 Closure Linter 版本 2.3.6 开始，只要成员被注释为 @private 而没有尾随下划线，就会发出错误“成员 不能有 @private JsDoc”。

此代码不会发出任何错误或警告。

/**
 * Stacker class.
 * @constructor
 * @param {frankenstein.app.Dictionary} dictionary Input dictionary for 
 *     stacking.
 */
frankenstein.app.Stacker = function(dictionary) {
  /** @private */ this.dictionary_ = dictionary;
};