Tài liệu Javascript

Question

Có điều gì đó giống như JavaDocs cho Javascript không? Khi tôi nhấn ctrl + dấu cách trong netbeans IDE trong khi

viết javascript, tài liệu javascript xuất hiện cho đối tượng được chỉ định. Nhưng tài liệu này tôi đoán là tài sản của Netbeans.

Nếu chúng tôi viết javascript theo cách nhận xét thích hợp, Netbeans cũng xây dựng tài liệu cho javascript tùy chỉnh của chúng tôi.

Chúng tôi có thể tìm thấy bất kỳ tài liệu javascript nào như vậy, bên ngoài Netbeans không? Vì vậy, chúng tôi có thể tham khảo nó?

Cảm ơn bạn đã trả lời.

Answer 1

Có một cái nhìn tại các trang doc tại Developer Network Mozilla (MDN) cho một tham chiếu tĩnh:

• https://developer.mozilla.org/en/JavaScript/Reference
• https://developer.mozilla.org/en/JavaScript/Guide

Tuy nhiên, tôi sợ rằng không có tab -kết hợp có thể được sử dụng bên trong một IDE.

Answer 2

Trong mã nguồn của hình tượng trưng trang chủ của Google, họ sử dụng các nhận xét trông rất giống với nhận xét javadoc, vì vậy phải có một số tiêu chuẩn mà ít nhất là Google sử dụng.

Dưới đây là một ví dụ:

/** 
* Configuration for a simulator speed setting. 
* - stepTime: ms between simulation steps that do something. 
* - emptyStepTime: ms between no-op steps. 
* - tapeTime: ms for a tape operation. 
* - branchTime: ms for a branch operation. 
* @typedef {{stepTime: number, tapeTime: number, emptyStepTime: number, 
*   branchTime: number}} 
* @private 
*/ 

Answer 3

Hãy thử một ứng dụng gọi là Ortelius. Nó sử dụng một số loại cú pháp như javadoc để genrate tài liệu. ortelius.marten.dk