mit einem Pfund/Rautezeichen

Question

ist

-Why are methods in Ruby documentation preceded by a hash sign? ähnlich Diese Frage zu JavaScript-Instanzmethoden Bezug

Ich verstehe, warum in Ruby Instanz-Methoden mit einem Rautenzeichen vorgegangen sind, spricht über SomeClass#someMethod von SomeObject.someMethod zu unterscheiden hilft und ermöglicht rdoc zu Arbeit. Und ich verstehe, dass die Autoren von PrototypeJS Ruby (mit gutem Grund) bewundern und so die hash mark convention in their documentation verwenden.

Meine Frage ist: Ist dies eine Standard-Praxis unter JavaScript-Entwicklern oder sind es nur Prototype-Entwickler, die das tun?

Anders gefragt, ist es richtig für mich, auf Instanzmethoden in Kommentaren/Dokumentation als SomeClass#someMethod zu verweisen? Oder sollte sich meine Dokumentation auf "SomeClass.someMethod" beziehen?

Answer 1

Ich denke, es kommt von Javadoc.

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

Answer 2

Nein, ich habe noch kein anderes JavaScript-Projekt erfüllt, die diese Schreibweise verwendet.

So etwas ist in JavaScript nützlich, denn im Gegensatz zu vielen anderen Sprachen würde Class.methodName auf Klassenmethoden wie String.fromCharCode verweisen, keine Instanzmethoden, worüber man öfter spricht. Die von myinstance.methodName aufgerufene Methode wäre nicht MyClass.methodName, sondern , und MyClass.prototype ist ein Ärgernis, um weiter zu tippen.

(Die Standard-JS-Bibliothek verwechselt dies viele Instanzmethoden haben auch einen entsprechenden Class, indem sie. Aber sie sind verschiedene Funktionen.)

es proepr für mich in den Kommentaren/Dokumentation zu Instanzmethoden beziehen als SomeClass # someMethod?

Machen Sie, was Sie wollen/am besten lesbar. Hier gibt es keinen Standard.