この質問は、Ruby ドキュメントのメソッドの前にハッシュ記号が付いているのはなぜですか? に似ています。
Ruby のインスタンス メソッドではシャープ記号を使用して処理を進める理由が理解SomeClass#someMethodできSomeObject.someMethodましrdocた。また、PrototypeJS の作成者は (正当な理由で) Ruby を高く評価しているため、ドキュメントでハッシュ記号規則を使用していることも理解しています。
私の質問は次のとおりです。これは JavaScript 開発者の間で標準的な方法ですか、それともこれを行うのはプロトタイプ開発者だけですか?
別の言い方をすれば、コメント/ドキュメントでインスタンス メソッドを と呼ぶのは適切SomeClass#someMethodですか? または、私のドキュメントは ``SomeClass.someMethod`' を参照する必要がありますか?
いいえ、この表記法を使用する別の JavaScript プロジェクトにまだ会ったことがありません。
ただし、このようなものは JavaScript では便利です。なぜなら、多くの言語とは異なり、 はインスタンス メソッドではなく、Class.methodNameのようなクラス メソッドを参照するからです。String.fromCharCodeによって呼び出されるメソッドはmyinstance.methodNamenot MyClass.methodNamebutMyClass.prototype.methodNameであり、MyClass.prototype入力し続けるのは面倒です。
(標準の JS ライブラリは、多くのインスタンス メソッドに対応するクラスメソッドも持たせることで、これを混乱させます。しかし、それらは異なる関数です。)
コメント/ドキュメントでインスタンスメソッドを SomeClass#someMethod と呼ぶのは適切ですか?
あなたが好きなこと/最も読みやすいと思うことをしてください。ここには基準がありません。
javadocから来ていると思います。
http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html# {@link}