How to document a function returned by a function using JSDoc

前端 未结 3 1946
终归单人心
终归单人心 2020-12-15 03:18

I am using JSDoc for parameter documentation.

It is clear how to document the parameter types for many_prompts, but what is the right way to document th

3条回答
  •  无人及你
    2020-12-15 04:04

    The way I prefer:

    /**
     * @param {number} count - number of times to prompt
     * @returns { (promt:string) => void } - the returned function
     */
      manyPrompts(count) {
          /**
           * My inner function
           *
           * @param {object} prompt Some parameter
           */
          const inner = function(prompt) {
            for (let i=0; i < count; i++) {
              alert(prompt);
            };
          };
          return inner;
      }
    

提交回复
热议问题