引用带有井号/井号的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库通过使许多实例方法也具有相应的类方法来混淆它。但它们是不同的函数。）

  

我是不是要将评论/文档中的实例方法称为SomeClass＃someMethod？

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

Answer 2

我认为它来自javadoc。

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