Đề cập đến javascript phương pháp dụ bằng dấu/băm

Question

Câu hỏi này cũng tương tự như Why are methods in Ruby documentation preceded by a hash sign?

Tôi hiểu lý do tại sao trong các phương pháp dụ Ruby đang tiến hành với một dấu hiệu pound, giúp phân biệt nói về SomeClass#someMethod từ SomeObject.someMethod và cho phép rdoc để công việc. Và tôi hiểu rằng các tác giả của PrototypeJS ngưỡng mộ Ruby (với lý do chính đáng) và vì vậy họ sử dụng hash mark convention in their documentation.

Câu hỏi của tôi là: đây có phải là thực hành tiêu chuẩn giữa các nhà phát triển JavaScript hay chỉ là các nhà phát triển Prototype làm việc này?

Được hỏi một cách khác, liệu tôi có nên tham khảo các phương pháp thể hiện trong các nhận xét/tài liệu dưới dạng SomeClass#someMethod không? Hoặc tài liệu của tôi nên tham khảo `` SomeClass.someMethod`?

Answer 1

Tôi nghĩ nó đến từ javadoc.

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

Answer 2

Không, tôi chưa gặp một dự án JavaScript sử dụng ký hiệu này.

Một cái gì đó như thế này là hữu ích trong JavaScript, tuy nhiên, bởi vì không giống như nhiều ngôn ngữ Class.methodName nên tham khảo classmethods như String.fromCharCode, không phải là phương pháp dụ. Phương thức được gọi bởi myinstance.methodName sẽ không phải là MyClass.methodName nhưng MyClass.prototype.methodName và MyClass.prototype là một ít phiền toái khi tiếp tục nhập.

(Thư viện JS tiêu chuẩn lẫn lộn này bằng cách làm nhiều phương pháp dụ cũng có một classmethod tương ứng. Nhưng chúng chức năng khác nhau.)

là nó proepr cho tôi để tham khảo các phương pháp dụ trong ý kiến ​​/ tài liệu như SomeClass # someMethod?

Làm những gì bạn thích/tìm thấy dễ đọc nhất. Không có tiêu chuẩn ở đây.