タグ付けされた質問 「jsdoc」

// My function does X and Y. // @params {object} parameters An object containing the parameters // @params {function} callback The callback function function(parameters, callback) { } しかし、parametersオブジェクトの構造をどのように説明すればよいですか？たとえば、次のようになります。 { 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 the type of …

144 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

@paramのJSDoc wikiによると、@ param はオプションで /** @param {String} [name] */ function getPerson(name) { } あなたはのparam示すことができ、インラインを使用して 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 

1つの文字列パラメータを受け入れる関数があります。このパラメーターは、いくつかの定義可能な値のうちの1つのみを持つことができます。同じことを文書化する最良の方法は何ですか？shapeTypeは、列挙型、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; }; 問題の2番目の部分は、の可能な値が、提案したものとして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 } しかし、desctructured関数パラメーターを使用するのが最善のアプローチであるかどうかはわかりません。オブジェクトを無視するか、何らかの方法で定義するか、それとも文書化するための最良の方法は何ですか？ …

90 arguments  ecmascript-6  jsdoc  destructuring 

次のようなものがあるとしましょう。 var someFunc = function() { // do something here with arguments } この関数がJSDocで任意の数の引数を取ることができることをどのように正しく文書化しますか？これは私の最善の推測ですが、それが正しいかどうかはわかりません。 /** * @param {Mixed} [...] Unlimited amount of optional parameters */ var someFunc = function() { // do something here with arguments } 関連：php-可変数のパラメーターを文書化する方法

84 javascript  jsdoc 

NodeJSにQライブラリを使用するなど、promiseオブジェクトを返すコードがいくつかあります。 var Q = require('q'); /** * @returns ??? */ function task(err) { return err? Q.reject(new Error('Some error')) : Q.resolve('Some result'); } JSDocを使用してそのような戻り値を文書化する方法は？

83 javascript  node.js  documentation  jsdoc  promise 

JsDocでvoidを返すメソッドまたは関数を宣言する特定の方法はありますか？現在、私はvoidデフォルトの戻り値であると信じており、他の戻り値を具体的に提供する必要があります。 /** * @return {Integer} The identifier for ... */

81 javascript  ide  jsdoc 

で関数構成を使用して定義された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, method = …

10 javascript  ecmascript-6  functional-programming  intellisense  jsdoc