@bro-dev0

Откуда берется текст для автодокументации?

/**
 * @typedef {integer} safeSearchInt - 1 is safe, -1 is moderate, and -2 is off
 */

/**
 * A result given from searching.
 * @see DDG#search
 * @typedef {Object} SearchResult
 * @property {string} [title] The title of the search result
 * @property {string} [description] The description from the result.
 * The description can be changed by DuckDuckGo depending on your search query.
 * @property {string} [rawDescription] Same as description but includes HTML elements.
 * @property {string} [description] The description from the result.
 * @property {number} [url] The URL of the search result
 */

Откуда берется текст для автодокументации? Вручную все так пишется, или тоже как то генерируется автоматом на основе функций?
  • Вопрос задан
  • 46 просмотров
Пригласить эксперта
Ответы на вопрос 1
profesor08
@profesor08 Куратор тега JavaScript
Среда разработки может иметь функционал задавать автоматически комментарии к коду. Например в phpstorm если написать /** и нажать enter перед ранее объявленной функцией, то он автоматически сгенерирует доки основываясь на аргументах функции.
/**
 * 
 * @property {string} [description]
 * @property {number} [url] 
 */
function bla(description, url) {
}


Программисту остается только написать комментарии к аргументам и описание функции.
Ответ написан
Комментировать
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Похожие вопросы
21 нояб. 2024, в 22:21
3000 руб./в час
21 нояб. 2024, в 21:42
100000 руб./за проект
21 нояб. 2024, в 21:30
500 руб./за проект