riferimento a JavaScript metodi di istanza con un cancelletto/hash

Question

Questa domanda è simile a Why are methods in Ruby documentation preceded by a hash sign?

capisco perché in Ruby metodi di istanza sono proceduto con un cancelletto, contribuendo a differenziare parlando SomeClass#someMethod da SomeObject.someMethod e permettendo rdoc a lavoro. E capisco che gli autori di PrototypeJS ammirano Ruby (a ragione) e quindi usano lo hash mark convention in their documentation.

La mia domanda è: questa è una pratica standard tra gli sviluppatori di JavaScript o è solo sviluppatori di prototipi che fanno questo?

Chiesto in un altro modo, è corretto per me fare riferimento ai metodi di istanza in commenti/documentazione come SomeClass#someMethod? O dovrebbe la mia documentazione fare riferimento a `` SomeClass.someMethod`?

Answer 1

Penso che provenga da javadoc.

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

Answer 2

No, non l'ho ancora incontrato un altro progetto JavaScript che usa questa notazione.

Tuttavia, qualcosa come questo è utile in JavaScript, perché a differenza di molte lingue Class.methodName fare riferimento a metodi di classe come String.fromCharCode, non a metodi di istanza, di cui si parla più spesso. Il metodo invocato da myinstance.methodName non è MyClass.methodName ma MyClass.prototype.methodName e MyClass.prototype è un fastidio continuare a digitare.

(La libreria standard JS confonde questo facendo molti metodi di istanza hanno anche un corrispondente classmethod. Ma sono diverse funzioni.)

è vero proepr per me di fare riferimento al metodo di istanza in commenti/documentazione come SomeClass # someMethod?

Fai quello che ti piace/trova più leggibile. Non c'è uno standard qui.