Что касается методов экземпляра JavaScript со знаком фунта/хеша
Этот вопрос подобен тому, Почему методы в документации Ruby предшествовавшие знаком хеша?
Я понимаю, почему в Ruby методы экземпляра продолжены со знаком фунта, помогая дифференцировать разговор о SomeClass#someMethod от SomeObject.someMethod и разрешение rdoc работать. И я понимаю, что авторы PrototypeJS восхищаются Ruby (с серьезным основанием) и таким образом, они используют конвенцию знака "диез" в своей документации.
Мой вопрос: действительно ли это - общепринятая практика среди разработчиков JavaScript или является ею просто Опытные разработчики, которые делают это?
Спрошенный иначе, это надлежащий, чтобы я обратился к методам экземпляра в комментариях/документации как SomeClass#someMethod? Или моя документация должна относиться к ''SomeClass.someMethod'?
2 ответа
Думаю, это из javadoc.
http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html# {@link}
Нет, я еще не встречал другого проекта JavaScript, который использует эту нотацию.
Что-то вроде этого полезно в JavaScript, потому что, в отличие от многих языков, Class.methodName будет относиться к таким методам классов, как String.fromCharCode , а не к методам экземпляров, каковы вы чаще говорят о. Метод, вызываемый myinstance.methodName , будет не MyClass.methodName , а MyClass.prototype.methodName , и MyClass.prototype является раздражение, чтобы продолжать печатать.
(Стандартная библиотека JS сбивает это с толку, заставляя многие методы экземпляра также иметь соответствующий метод класса. Но это разные функции.)
Я должен ссылаться на методы экземпляра в комментариях / документации как SomeClass # someMethod ?
Делайте то, что вам нравится / считает наиболее читаемым. Здесь нет стандарта.