1

JSDoc, похоже, не подходит для большинства моих функций. Вот пример:Как документировать функции с помощью JSDoc

/** 
* Function one. 
*/ 
(function one() { 
    /** 
    * Function two. 
    */ 
    function two() { 
     /** 
     * Function three. 
     */ 
     function three() { 
     } 
    } 
})(); 

var four = { 
    /** 
    * Function five/six. 
    */ 
    five: function six() { 
    }, 
    /** 
    * Function seven/eight. 
    */ 
    seven: function eight() { 
    }, 
}; 

nine.ten = { 
    /** 
    * Function eleven/twelve. 
    */ 
    eleven: function twelve() { 
     /** 
     * Function thirteen/fourteen. 
     */ 
     var thirteen = function fourteen() { 
     }; 
    }, 
    /** 
    * Function fifteen/sixteen. 
    */ 
    fifteen: function sixteen() { 
    }, 
}; 

/** 
* Function eighteen 
*/ 
seventeen(function eighteen() { 
}); 

/** 
* Function twenty. 
*/ 
nineteen(function twenty() { 
    /** 
    * Function twentyTwo. 
    */ 
    twentyOne(function twentyTwo() { 
    }); 
}); 

/** 
* Function twentyThree. 
*/ 
function twentyThree() { 
} 

JSDoc только подбирает функцию двадцать три. Остальные полностью упущены.

Что я делаю неправильно?

+1

Я никогда не использовал JSDoc раньше, но от глядя на их документации, я не знаю, почему любой из ваших все будет работать. Я думаю, вам нужно вернуться и прочитать документы для JSDoc. Например, я думаю, что 'four' должен быть документирован как' @ namespace' (то же самое для вашего IIFE). И я думаю, вам нужно использовать '@ name' и' @ lends' в определенных местах – Ian

ответ

4

Это один пример, который даст вам больше выход из JSDoc (3):

/** 
* Function one. 
* @namespace one 
*/ 
(function one() { 
    /** 
    * Function two. 
    * @namespace two 
    * @memberof one 
    */ 
    function two() { 
     /** 
     * Function three. 
     * @memberof one.two 
     */ 
     function three() { 
     } 
    } 
})(); 
Смежные вопросы