Cách tiêu chuẩn để thêm tài liệu vào một hàm JavaScript là gì?

Question

Tôi đang xem tạo tài liệu API cho dự án JavaScript. JavaScript có bất cứ điều gì tương tự như docstring của Python?

function add(a, b) { 
    /** 
    Returns the sum of `a` and `b`. 
    */ 
    return (a - 0) + (b - 0); 
} 

Answer 1

Bạn đã thấy JSDoc (mà hiện đã được superceded bởi JSDoc toolkit)?

Answer 2

JSDoc là một cách để thực hiện.

/** 
* Adds two numbers. 
*/ 
function add(a, b) { 
    return a+b; 
} 

Answer 3

Khi tôi cần, JSDoc là công cụ duy nhất có sẵn và khá lộn xộn. Chúng tôi luôn có tràn ngăn xếp vì họ sử dụng các biểu thức chính quy và thường xuyên để phân tích cú pháp nguồn. Ngay từ cái nhìn đầu tiên, JSDoc Toolkit như đã đề cập, chúng hiện đang sử dụng JavaScript.

Answer 4

PDoc là trình tạo tài liệu trực tuyến cho thư viện Prototype, được viết bằng Ruby.