引用带有井号/井号的javascript实例方法

Question

这个问题类似于为什么Ruby文档中的方法前面有一个井号？

我明白了为什么在Ruby中的实例方法与井号进行,有助于区分谈论SomeClass#someMethod的SomeObject.someMethod,并允许rdoc工作.我理解PrototypeJS的作者钦佩Ruby(有充分理由),因此他们在文档中使用了散列标记约定.

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

问另一种方式,我在评论/文档中引用实例方法是否合适SomeClass#someMethod？或者我的文档是否应该引用``SomeClass.someMethod`？

Answer 1

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

这样的东西在JavaScript中很有用,因为与许多语言不同,它Class.methodName会引用类String.fromCharCode方法,而不是实例方法,这是你经常谈论的内容.通过调用该方法myinstance.methodName会不会MyClass.methodName,但是MyClass.prototype.methodName,和MyClass.prototype是一个烦恼,保持打字.

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

我是不是要在评论/文档中引用实例方法作为SomeClass#someMethod？

做你喜欢/最可读的事情.这里没有标准.

Answer 2

我认为它来自javadoc。

http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html# {@link}