// My function does X and Y. // @params {object} parameters An object containing the parameters // @params {function} callback The callback function function(parameters, callback) { } Tetapi bagaimana saya menggambarkan bagaimana objek parameter harus disusun? Contohnya harus seperti: { setting1...
Bagaimana saya bisa memberi tahu JSDoc tentang struktur suatu objek yang dikembalikan. Saya telah menemukan @return {{field1: type, field2: type, ...}} descriptionsintaks dan mencobanya: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event}...
Menurut wiki JSDoc untuk @param Anda dapat menunjukkan bahwa @param bersifat opsional /** @param {String} [name] */ function getPerson(name) { } dan Anda dapat menunjukkan parameter sebaris menggunakan function getPerson(/**String*/ name) { } Dan saya bisa menggabungkannya seperti berikut,...
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......
Saya memiliki fungsi yang menerima satu parameter string. Parameter ini hanya dapat memiliki satu dari beberapa kemungkinan nilai yang ditentukan. Apa cara terbaik untuk mendokumentasikan hal yang sama? Haruskah shapeType didefinisikan sebagai enum atau TypeDef atau yang
Sebelumnya saya selalu mendokumentasikan parameter objek saya sebagai berikut: /** * Description of the function * * @param {Object} config - The configuration * @param {String} config.foo * @param {Boolean} [config.bar] - Optional value * @return {String} */ function doSomething (config...
Saya memiliki fungsi gaya ES6 yang didefinisikan menggunakan komposisi fungsi dengan asyncPipe. import { getItemAsync } from 'expo-secure-store'; const asyncPipe = (...fns) => x => fns.reduce(async (y, f) => f(await y), x); const getToken = () => getItemAsync('token'); const...