16

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

我理解为什么在 Ruby 实例方法中以井号开头,有助于区分谈论SomeClass#someMethodSomeObject.someMethod允许rdoc工作。而且我知道 PrototypeJS 的作者很欣赏 Ruby(有充分的理由),因此他们在文档中使用了井号约定

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

换一种方式问,我是否可以将评论/文档中的实例方法称为SomeClass#someMethod? 或者我的文档应该参考“SomeClass.someMethod”?

4

2 回答 2

13

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

不过,像这样的东西在 JavaScript 中很有用,因为与许多语言不同的是,它Class.methodName指的是类String.fromCharCode方法,而不是你经常谈论的实例方法。by 调用的方法myinstance.methodName不是MyClass.methodNamebut MyClass.prototype.methodName,并且MyClass.prototype是不断输入的烦恼。

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

将注释/文档中的实例方法称为 SomeClass#someMethod 对我来说是否合适?

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

于 2010-04-06T20:41:11.877 回答
7

我认为它来自javadoc。

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

于 2010-04-06T20:16:53.867 回答