Di JSDoc, dokumentasi terbaik yang dapat saya temukan menunjukkan menggunakan berikut ini jika Anda memiliki array dengan tipe tertentu (seperti array string) seperti:
/**
* @param {Array.<string>} myStrings All my awesome strings
*/
function blah(myStrings){
//stuff here...
}
Bagaimana Anda mengganti tanda tanya di bawah ini dengan menentukan sebuah array objek?
/**
* @param {???????} myObjects All of my equally awesome objects
*/
function blah(myObjects){
//stuff here...
}
javascript
documentation
jsdoc
sinar
sumber
sumber
Jawaban:
Anda harus lebih spesifik apa yang Anda maksud dengan JSDoc - ini adalah istilah umum yang mencakup hampir semua alat dokumentasi bergaya JavaDoc untuk JavaScript.
Sintaks yang Anda gunakan untuk larik string terlihat seperti yang didukung oleh Google Closure Compiler .
Menggunakan ini, array Objek akan menjadi:
Atau hanya serangkaian apa saja - ini seharusnya bekerja dengan hampir semua alat dokumen:
jsdoc-toolkit , JSDoc 3 , dan JSDuck mendukung sintaks berikut untuk menunjukkan larik objek:
EDIT
Jika Anda mengetahui kunci dan jenis variabel dari nilai, Anda juga dapat melakukan:
atau
sumber
{Array<Object>}
. Hanya untuk terus memperbarui posting ini.Array.<string[]>