參考JavaScript的實例方法與英鎊/井號

Question

這個問題類似於Why are methods in Ruby documentation preceded by a hash sign?

我明白了爲什麼在Ruby中的實例方法與井號進行，有助於區分SomeObject.someMethod談論SomeClass#someMethod並允許rdoc到工作。我明白PrototypeJS的作者很欣賞Ruby（有充分的理由），所以他們使用hash mark convention in their documentation。

我的問題是：這是JavaScript開發人員之間的標準做法還是隻是Prototype開發人員這樣做？

問另一種方式，我是否可以在評論/文檔中將實例方法稱爲SomeClass#someMethod？或者我的文檔應該引用「SomeClass.someMethod」？

Answer 1

我認爲它來自javadoc。

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

Answer 2

不，我還沒有遇到一個使用這個符號另一個JavaScript項目。

雖然這樣的東西在JavaScript中很有用，因爲與許多語言不同，Class.methodName會引用像String.fromCharCode這樣的類方法，而不是您更經常談論的實例方法。由myinstance.methodName調用的方法將不是MyClass.methodName，但MyClass.prototype.methodName和MyClass.prototype是一個煩惱，繼續打字。

（標準JS庫通過使許多實例方法也有相應的類方法混淆了這一點。但他們不同的功能。）

是proepr爲我指的意見/文檔實例方法作爲SomeClass＃someMethod？

做你喜歡/發現最可讀的東西。這裏沒有標準。