JSDoc: Làm cách nào để ghi lại "tùy chọn" đối tượng theo nghĩa đen cho "lớp" cha mẹ?

Question

Tôi đang sử dụng lớp cơ sở "$.widget()" của jQuery cung cấp phương thức option(). Vì phương thức này không có trong mã của tôi, tôi không có chỗ để ghi lại đối số.

Tôi đã cố gắng đặt jsDoc trên các trường trong tùy chọn mặc định theo nghĩa đen, nhưng chúng đơn giản là không được chọn. Sau đó, tôi đã cố gắng sử dụng các thẻ @class và @lends trên cùng một đối tượng theo nghĩa đen, nhưng điều này có thể khá khó hiểu vì đối tượng theo nghĩa đen không thực sự là một lớp.

Một phương án khác mà tôi đã thử nghiệm là đặt một cái gì đó như @param options.field description vào jsDoc của hàm tạo. Tuy nhiên, điều này có bất lợi khi tách tài liệu khỏi mã. Ngoài ra, hàm tạo không thực sự có một đối số được gọi là options vì tất cả được xử lý bởi jQuery.

Chuyên gia Javascript của bạn xử lý việc này như thế nào? Thẻ mới có nên được đề xuất không?

Answer 1

Nếu tôi hiểu chính xác câu hỏi của bạn, bạn có một chức năng lấy đối tượng tùy chọn và bạn muốn ghi lại tất cả các thành viên của nó?

Một ví dụ thô làm thế nào để làm điều đó trong JSDoc như sau:

/** 
* @description 
* Compliment someone on their something. 
* 
* @param {Object} options 
* @param {String} options.name A person's name 
* @param {String} options.feature A person's property 
*/ 
function flatter (options) { 
    options = options || {}; 
    console.log('%s, loving your %s!', options.name, options.feature); 
}