JSDoc. Могу ли я поместить описание функций в начале файла?
У меня есть какой-то файл. Это выглядит так:
/**
* @file Description of this file.
*/
/**
* This is the main function that which starts execution.
*/
function main() {
func1();
func2();
}
/**
* This function № 1 does something.
*
* @param {number} arg1 some description.
*
* @return {number} some description.
*/
function func1(arg1) {
return 0;
}
/**
* This function № 2 does something.
*
* @param {number} arg2 some description.
*
* @return {number} some description.
*/
function func2(arg2) {
return 0;
}
Я хотел бы поместить описание функций в начале файла. Например:
/**
* @file Description of this file.
*
* @function func1 this function № 1 does something.
* @function func2 this function № 2 does something.
*/
Но @function может принимать только имя параметра, а не описание. Также я не видел конкретных примеров этого. Итак, я немного запутался.
Вопрос: Разрешено ли помещать описание функций в начало файла? Если так, то каков наилучший способ сделать это?