Все официальные примеры JSDoc имеют наивно простые строки документации, например:
/**
* @param {string} author - The author of the book.
*/
Проблема заключается в том, что в реальной документации вы часто имеете более длинные строки документации:
/**
* @param {string} author - The author of the book, presumably some person who writes well
*/
Но так как большинство компаний (по причинам законной удобочитаемости) имеют ограничения на длину строки, это часто неприемлемо. Однако то, что я не могу понять, - это то, что "правильный" способ разбить эти строки должен быть.
Я мог бы сделать:
/**
* @param {string} author - The author of the book, presumably some
* person who writes well
*/
Но это трудно читать. Вместо этого я мог бы сделать:
/**
* @param {string} author - The author of the book, presumably some
* person who writes well
*/
Это выглядит лучше, но это может привести к тонне строк, особенно если параметр имеет длинное имя:
/**
* @param {string} personWhoIsTheAuthorOfTheBook - The author of the
* book, presumably
* some person who
* writes well
*/
Итак, мой вопрос в том, каков правильный/официальный/канонический способ форматирования длинных строк @param (в коде, а не в сгенерированном JSDoc)... или действительно какие-то длинные строки аннотаций, если на то пошло.
