javascript - 使用井号/井号引用 javascript 实例方法

Question

这个问题类似于Why are methods in Ruby documentation preceded by a hash sign?

我理解为什么在 Ruby 中实例方法以井号开头，有助于区分谈论 SomeClass#someMethod 和 SomeObject.someMethod 并允许 rdoc 工作。我知道 PrototypeJS 的作者很欣赏 Ruby(有充分的理由)所以他们使用 hash mark convention in their documentation .

我的问题是:这是 JavaScript 开发人员的标准做法，还是只是原型(prototype)开发人员这样做？

换个方式问，我在注释/文档中将实例方法称为 SomeClass#someMethod 是否合适？还是我的文档应该引用 ``SomeClass.someMethod`？

Answer 1

不，我还没有遇到另一个使用这种表示法的 JavaScript 项目。

虽然这样的东西在 JavaScript 中很有用，因为与许多语言不同，Class.methodName 会引用类方法，如 String.fromCharCode，而不是实例方法你经常谈论。 myinstance.methodName 调用的方法不是 MyClass.methodName 而是 MyClass.prototype.methodName 和 MyClass.prototype 继续打字很烦人。

(标准 JS 库通过使许多实例方法也具有相应的类方法来混淆这一点。但它们是不同的函数。)

is it proepr for me to refer to instance methods in comments/documentation as SomeClass#someMethod?

做你喜欢做的/找到最可读的。这里没有标准。