Se référant à javascript méthodes d'instance avec une livre/signe dièse

Question

Cette question est similaire à Why are methods in Ruby documentation preceded by a hash sign?

Je comprends pourquoi les méthodes d'instance Ruby sont procédé à un signe dièse, aidant à différencier les parler SomeClass#someMethod de SomeObject.someMethod et permettant rdoc à travail. Et je comprends que les auteurs de PrototypeJS admirent Ruby (avec raison) et donc ils utilisent le hash mark convention in their documentation.

Ma question est la suivante: est-ce une pratique courante chez les développeurs JavaScript ou est-ce seulement les développeurs de prototypes qui font cela?

Demandé d'une autre manière, est-il approprié pour moi de me référer aux méthodes d'instance dans les commentaires/documentation comme SomeClass#someMethod? Ou ma documentation devrait-elle se référer à `` SomeClass.someMethod`?

Answer 1

Je pense que ça vient de javadoc.

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

Answer 2

Non, je ne l'ai pas encore rencontré un autre projet JavaScript qui utilise cette notation. Mais quelque chose comme ceci est utile en JavaScript, car contrairement à de nombreux langages, Class.methodName ferait référence à des méthodes de classe comme String.fromCharCode, pas des méthodes d'instance dont vous parlez plus souvent. La méthode invoquée par myinstance.methodName ne serait pas MyClass.methodName mais MyClass.prototype.methodName, et MyClass.prototype est un désagrément pour continuer à taper.

(La bibliothèque standard JS embrouille ce en faisant de nombreuses méthodes d'instance ont également une classmethod correspondante. Mais ils sont différentes fonctions.)

est-il proepr pour moi de se référer à des méthodes d'instance dans les commentaires/documentation comme SomeClass # someMethod?

Faites ce que vous aimez/trouvez le plus lisible. Il n'y a pas de norme ici.