属性和方法名称的下划线前缀仅仅是一种约定吗？

Question

JavaScript 中的下划线前缀是否只是一种约定，例如 Python 中的私有类方法是？

来自 2.7 Python 文档：

“私有”实例变量 只能从内部访问 Python 中不存在对象。 但是，有一个约定是 紧随其后的是大多数 Python 代码：一个名字 以下划线为前缀（例如 _spam) 应被视为 API 的非公开部分（无论是 是函数、方法或数据 成员）。

这也适用于 JavaScript 吗？

以这段 JavaScript 代码为例：

function AltTabPopup() {
    this._init();
}

AltTabPopup.prototype = {
    _init : function() {
        ...
    }
}

另外，使用下划线前缀的变量。

    ...
    this._currentApp = 0;
    this._currentWindow = -1;
    this._thumbnailTimeoutId = 0;
    this._motionTimeoutId = 0;
    ...

只有约定？还是下划线前缀后面有更多内容？

---

我承认我的问题与 this question 非常相似，但它并没有让人更清楚 JavaScript 中下划线前缀的重要性。

Answer 1

欢迎来到 2019 年！

似乎proposal 扩展类语法以允许# 前缀变量是私有的。 Chrome 74 ships 支持。

_ 前缀变量名按照惯例被认为是私有的，但仍然是公共的。

这种语法试图既简洁又直观，尽管它与其他编程语言有很大不同。

为什么在所有 Unicode 代码点中选择了印记 #？

• @ 是最初的最爱，但后来被装饰者采用。 TC39 曾考虑交换装饰器和私有状态标志，但委员会决定遵从转译器用户的现有用法。
• _ 会导致与现有 JavaScript 代码的兼容性问题，这使得 _ 长期出现在标识符或（公共）属性名称的开头。

该提案于 2017 年 7 月进入第 3 阶段。从那时起，就各种替代方案进行了广泛的思考和长时间的讨论。 最后，这一思考过程和持续的社区参与导致对该存储库中的提案重新达成共识。基于该共识，该提案的实施正在向前推进。

见https://caniuse.com/#feat=mdn-javascript_classes_private_class_fields

Answer 2

JavaScript 实际上确实支持封装，通过涉及hiding members in closures (Crockford) 的方法。也就是说，它有时很麻烦，并且下划线约定是一个很好的约定，可用于一些私有的东西，但实际上您需要隐藏。

Answer 3

“只有约定？还是下划线前缀后面有更多内容？”

除了隐私约定之外，我还想帮助人们意识到下划线前缀也用于依赖于独立参数的参数，特别是在 URI 锚映射中。从属键始终指向映射。

示例（来自https://github.com/mmikowski/urianchor）：

$.uriAnchor.setAnchor({
  page   : 'profile',
  _page  : {
    uname   : 'wendy',
    online  : 'today'
  }
});

浏览器搜索字段上的 URI 锚点更改为：

\#!page=profile:uname,wendy|online,today

这是用于根据哈希更改驱动应用程序状态的约定。

Answer 4

import/export 现在正在使用 ES6 完成这项工作。如果我的大部分函数都是导出的，我仍然倾向于在未导出的函数前面加上 _。

如果您只导出一个类（如在 Angular 项目中），则根本不需要它。

export class MyOpenClass{

    open(){
         doStuff()
         this._privateStuff()
         return close();
    }

    _privateStuff() { /* _ only as a convention */} 

}

function close(){ /*... this is really private... */ }

Answer 5

JSDoc 3 允许您使用 @access private（以前的 @private 标签）注释您的函数，这对于向其他开发人员广播您的意图也很有用 - http://usejsdoc.org/tags-access.html

Answer 6

这只是一个约定。 Javascript 语言对以下划线字符开头的标识符没有任何特殊含义。

也就是说，对于不支持开箱即用 encapsulation 的语言来说，这是一个非常有用的约定。虽然没有办法防止有人滥用您的类的实现，但至少它确实阐明了您的意图，并首先记录了诸如错误之类的行为。