这个问题类似于 为什么Ruby文档中的方法前面有一个井号?
我理解为什么在Ruby实例方法中使用井号来帮助区分谈论 SomeClass#someMethod
从 SomeObject.someMethod
并允许 rdoc
上班。我知道PrototypeJS的作者很欣赏Ruby(有充分的理由),因此他们使用了 其文档中的哈希标记约定。
我的问题是:这是JavaScript开发人员的标准做法还是只是原型开发人员这样做?
问另一种方式,我在评论/文档中引用实例方法是否合适 SomeClass#someMethod
?或者我的文档是否应该引用``SomeClass.someMethod`?
不,我还没有遇到另一个使用这种表示法的JavaScript项目。
但是,这样的东西在JavaScript中很有用,因为与许多语言不同 Class.methodName
会引用像类的方法 String.fromCharCode
,而不是你经常谈论的实例方法。由...调用的方法 myinstance.methodName
不会 MyClass.methodName
但 MyClass.prototype.methodName
,和 MyClass.prototype
打字是一种烦恼。
(标准JS库通过使许多实例方法也具有相应的类方法来混淆它。但它们是不同的函数。)
对于我来说,在someClass#someMethod中引用注释/文档中的实例方法是不是很合适?
做你喜欢/最可读的。这里没有标准。