Câu hỏi được gắn thẻ «jsdoc»

// My function does X and Y. // @params {object} parameters An object containing the parameters // @params {function} callback The callback function function(parameters, callback) { } Nhưng làm thế nào để tôi mô tả làm thế nào các đối tượng tham số nên được cấu trúc? Ví dụ, nó …

316 javascript  jsdoc 

Làm thế nào tôi có thể nói với JSDoc về cấu trúc của một đối tượng được trả về. Tôi đã tìm thấy @return {{field1: type, field2: type, ...}} descriptioncú pháp và thử nó: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e …

144 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

Theo wiki JSDoc cho @param, bạn có thể chỉ ra @param là tùy chọn sử dụng /** @param {String} [name] */ function getPerson(name) { } và bạn có thể chỉ ra một param inline bằng cách sử dụng function getPerson(/**String*/ name) { } Và tôi có thể kết hợp chúng …

119 javascript  google-closure-compiler  jsdoc 

Trong JSDoc, tài liệu tốt nhất mà tôi có thể tìm thấy cho thấy cách sử dụng sau đây nếu bạn có một mảng thuộc loại cụ thể (chẳng hạn như một mảng chuỗi) như: /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... } …

105 javascript  documentation  jsdoc 

Tôi đang có một hàm chấp nhận một tham số chuỗi. Tham số này chỉ có thể có một trong một vài giá trị có thể được xác định. Cách tốt nhất để ghi lại tài liệu giống nhau là gì? ShapeType có nên được định nghĩa là enum hoặc …

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

Trước đây, tôi luôn ghi lại các thông số đối tượng của mình như sau: /** * Description of the function * * @param {Object} config - The configuration * @param {String} config.foo * @param {Boolean} [config.bar] - Optional value * @return {String} */ function doSomething (config = {}) { …

90 arguments  ecmascript-6  jsdoc  destructuring 

Tôi có một số mã trả về một đối tượng hứa, ví dụ: sử dụng thư viện Q cho NodeJS. var Q = require('q'); /** * @returns ??? */ function task(err) { return err? Q.reject(new Error('Some error')) : Q.resolve('Some result'); } Làm thế nào để ghi lại giá trị trả …

83 javascript  node.js  documentation  jsdoc  promise 

Giả sử bạn có một cái gì đó như sau: var someFunc = function() { // do something here with arguments } Làm thế nào bạn sẽ ghi lại một cách chính xác rằng hàm này có thể nhận bất kỳ số đối số nào trong JSDoc? Đây là dự …

82 javascript  jsdoc 

Có cách cụ thể nào để khai báo một phương thức hoặc một hàm để trả về void trong JsDoc không? Hiện tại, tôi tin rằng đó voidlà giá trị trả về mặc định và các giá trị trả về khác phải được cung cấp cụ thể: /** * @return …

81 javascript  ide  jsdoc 

Tôi có một hàm kiểu ES6 được xác định bằng cách sử dụng thành phần hàm với 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 …

10 javascript  ecmascript-6  functional-programming  intellisense  jsdoc