Ссылаясь на методы экземпляра javascript со знаком фунта / хеша

Question

Этот вопрос похож на Почему методам в документации по Ruby предшествует знак хеша?

Я понимаю, почему в экземплярах Ruby методы выполняются со знаком фунта, помогая отличить разговоры о SomeClass#someMethod от SomeObject.someMethod и позволяя rdoc работать. И я понимаю, что авторы PrototypeJS восхищаются Ruby (не без оснований) и поэтому используют в своей документации соглашение о хеш-метках .

У меня вопрос: это стандартная практика среди разработчиков JavaScript или это делают только разработчики прототипов?

Спросил по-другому, уместно ли мне ссылаться на методы экземпляра в комментариях / документации как SomeClass#someMethod? Или моя документация должна ссылаться на `` SomeClass.someMethod`?

Answer 1

Нет, я еще не встречал другой проект JavaScript, который использует эту запись.

Нечто подобное полезно в JavaScript, хотя, в отличие от многих языков, Class.methodName будет ссылаться на методы класса, такие как String.fromCharCode, а не на методы экземпляра, о которых вы чаще говорите. Метод, вызванный myinstance.methodName, будет не MyClass.methodName, а MyClass.prototype.methodName, а MyClass.prototype - раздражение, чтобы продолжать печатать.

(Стандартная библиотека JS смущает это тем, что многие методы экземпляров также имеют соответствующий метод класса. Но это разные функции.)

Можно ли ссылаться на методы экземпляра в комментариях / документации как SomeClass # someMethod?

Делайте то, что вам нравится / находите наиболее читабельным. Здесь нет стандарта.

Answer 2

Я думаю, что это происходит от Javadoc.

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