Nawiązując do JavaScript metody instancji ze znakiem funta/hash

Question

To pytanie jest podobna do Why are methods in Ruby documentation preceded by a hash sign?

rozumiem dlaczego w Ruby metody instancji są przystąpił ze znakiem funta, pomagając w celu odróżnienia mówić o SomeClass#someMethod z SomeObject.someMethod i pozwalając rdoc do praca. Rozumiem, że autorzy PrototypeJS podziwiają Ruby (nie bez powodu) i dlatego używają nazwy hash mark convention in their documentation.

Moje pytanie brzmi: czy jest to standardowa praktyka wśród programistów JavaScript, czy jest to po prostu twórcami prototypów, którzy to robią?

Zapytany w inny sposób, czy właściwe jest odwoływanie się do metod instancji w komentarzach/dokumentacji jako SomeClass#someMethod? A może moja dokumentacja powinna odnosić się do `` SomeClass.someMethod`?

Answer 1

Myślę, że pochodzi z javadoc.

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

Answer 2

Nie, jeszcze nie spotkałem innego projektu JavaScript, który używa tego zapisu.

Coś takiego jest przydatne w JavaScript, ponieważ w przeciwieństwie do wielu języków Class.methodName odwoływałoby się do metod klasowych, takich jak String.fromCharCode, a nie do metod instancji, o czym często mówisz. Metoda wywoływana przez myinstance.methodName nie byłaby MyClass.methodName, ale MyClass.prototype.methodName, a MyClass.prototype jest uciążliwością w utrzymywaniu pisania.

(Standardowa biblioteka JS myli to poprzez wiele metod przykład mieć również odpowiednią classmethod. Ale są różne funkcje.)

jest to proepr mi odnieść się do metody instancji w komentarzach/dokumentacja jako SomeClass # someMethod?

Rób to, co lubisz/znajdź najbardziej czytelne. Tu nie ma standardu.