How to document a function returned by a function using JSDoc

前端 未结 3 1945
终归单人心
终归单人心 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 03:57

    You can document the inner function and then reference it like so

    /**
     * @param {Number} - number of times to prompt
     * @return {many_prompts~inner} - the returned function
     */
    function many_prompts(count){
      /**
       * My inner function
       *
       * @param {object} prompt Some parameter
       */
      var inner = function(prompt){
        for(var i=0;i

提交回复
热议问题