2017-06-20 24 views
5

Nếu tôi có một hàm JavaScript chụp một đối tượng như một tham số, tôi có thể mô tả các đặc tính mong đợi của đối tượng với JSDoc như thế này:Làm thế nào để mô tả đối số đối tượng destructured trong JSDoc

/** 
* @param bar 
* @param bar.baz {number} 
* @param bar.qux {number} 
*/ 
function foo(bar) { 
    return bar.baz + bar.qux; 
} 

Làm thế nào để mô tả các đặc tính này nếu tôi xác định chức năng của tôi với ECMAScript 6 destructuring, không cho các đối tượng tham số thực một tên ở tất cả?

const foo = ({ baz, qux }) => baz + qux; 

Trả lời

6

Hóa ra JSDoc không hỗ trợ hủy bằng cách tạo nên tên trình giữ chỗ. Nó thiếu tài liệu chính thức.

https://github.com/jsdoc3/jsdoc/issues/987

/** 
* @param {Object} param - this is object param 
* @param {number} param.baz - this is property param 
* @param {number} param.qux - this is property param 
*/ 
const foo = ({ baz, qux }) => baz + qux; 
Các vấn đề liên quan