คำถามติดแท็ก jsdoc

// My function does X and Y. // @params {object} parameters An object containing the parameters // @params {function} callback The callback function function(parameters, callback) { } แต่ฉันจะอธิบายได้อย่างไรว่าวัตถุพารามิเตอร์ควรมีโครงสร้างอย่างไร ตัวอย่างเช่นควรมีลักษณะดังนี้: { setting1 : 123, // (required, integer) setting2 : 'asdf' // (optional, string) }

316 javascript  jsdoc 

ฉันจะบอก JSDoc เกี่ยวกับโครงสร้างของวัตถุที่ส่งคืนได้อย่างไร ฉันพบ@return {{field1: type, field2: type, ...}} descriptionไวยากรณ์แล้วลอง: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch event or a jQuery event wrapping such an * event. * @param {string} [type="page"] * A string representing …

144 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

ตาม JSDoc wiki สำหรับ@paramคุณสามารถระบุว่า @param เป็นทางเลือกโดยใช้ /** @param {String} [name] */ function getPerson(name) { } และคุณสามารถระบุพารามิเตอร์แบบอินไลน์ได้โดยใช้ function getPerson(/**String*/ name) { } และฉันสามารถรวมเข้าด้วยกันดังต่อไปนี้ซึ่งใช้ได้ดี /** @param [name] */ function getPerson(/**String*/name) { } แต่อยากทราบว่ามีวิธีทำแบบอินไลน์ทั้งหมดไหมถ้าเป็นไปได้

119 javascript  google-closure-compiler  jsdoc 

ใน JSDoc เอกสารที่ดีที่สุดที่ฉันสามารถหาได้แสดงให้ใช้สิ่งต่อไปนี้หากคุณมีอาร์เรย์ประเภทเฉพาะ (เช่นอาร์เรย์ของสตริง) เป็น: /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... } คุณจะแทนที่เครื่องหมายคำถามด้านล่างเพื่อระบุอาร์เรย์ของวัตถุได้อย่างไร /** * @param {???????} myObjects All of my equally awesome objects */ function blah(myObjects){ //stuff here... }

105 javascript  documentation  jsdoc 

ฉันมีฟังก์ชันที่ยอมรับพารามิเตอร์สตริงหนึ่งตัว พารามิเตอร์นี้สามารถมีค่าที่เป็นไปได้ที่กำหนดไว้เพียงไม่กี่ค่าเท่านั้น วิธีที่ดีที่สุดในการจัดทำเอกสารแบบเดียวกันคืออะไร? ควรกำหนด shapeType เป็น enum หรือ TypeDef หรืออย่างอื่น? Shape.prototype.create = function (shapeType) { // shapeType can be "rect", "circle" or "ellipse"... this.type = shapeType; }; Shape.prototype.getType = function (shapeType) { // shapeType can be "rect", "circle" or "ellipse"... return this.type; }; ส่วนที่สองของปัญหาคือค่าที่เป็นไปได้ของshapeTypeไม่เป็นที่รู้จักในไฟล์ที่กำหนดshapeTypeเป็นสิ่งที่คุณแนะนำ มีไฟล์หลายไฟล์ที่มาจากนักพัฒนาหลายคนซึ่งอาจเพิ่มค่าที่เป็นไปได้ของshapeTypeไฟล์. PS: กำลังใช้ jsdoc3

96 google-closure-compiler  google-closure  jsdoc  code-documentation 

ก่อนหน้านี้ฉันได้บันทึกพารามิเตอร์ออบเจ็กต์ของฉันไว้เสมอดังนี้: /** * Description of the function * * @param {Object} config - The configuration * @param {String} config.foo * @param {Boolean} [config.bar] - Optional value * @return {String} */ function doSomething (config = {}) { const { foo, bar } = config; console.log(foo, bar); // do something } แต่ฉันไม่แน่ใจว่าแนวทางที่ดีที่สุดคืออะไรกับพารามิเตอร์ฟังก์ชัน …

90 arguments  ecmascript-6  jsdoc  destructuring 

ฉันมีฟังก์ชั่น ES6 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 liftedGetToken = async ({ ...rest }) => ({ token: await getToken(), ...rest, }); const liftedFetch = ({ body, route, token, …

10 javascript  ecmascript-6  functional-programming  intellisense  jsdoc