Документация по функциям javascript

Question

Новичок оповещения!

Когда вам требуется модуль в вашем коде, такой как ниже, и вы наводите указатель мыши на функцию, которую вы вызываете из этого модуля, вы получаете всплывающее окно с некоторой документацией о функции, то есть параметрах, возвратах, выбросах и т. Д. И т. Д.

const AWS = require("aws-sdk");
const cognito = new AWS.CognitoIdentityServiceProvider({ apiVersion: "2016-04-18" });

В моих собственных модулях, где я написал функции и затем потребовал их, я задокументировал каждую функцию в соответствии с приведенным ниже примером

/**
 * Given a user's profile, create a new session (kill any previous sessions)
 * @param profile The users profile
 * @throws Exception if the user is not a valid user.
 */ 

Когда я наведу курсор на функцию в модуле, который содержит код функции, я вижу окно документации.

Однако, когда я наведу курсор на функцию в модуле, который фактически вызывает функцию, я ничего не получаю.

Вы также получаете функциональность типа intellisense, поэтому, когда вы печатаете cognito. вы получите всплывающее окно со всеми доступными функциями.

Чего не хватает, чтобы мои функции выглядели так же? Все они экспортируются с использованием

module.exports.funcName = funcName;

Кто-нибудь?

заранее спасибо

Answer 1

Надеюсь, что это поможет другим новичкам делать глупости, как я.

Наконец-то нашел ответ на мой вопрос. По сути, мои пути на локальном ноутбуке не совпадали с путями на сервере сборки, поэтому в моих локальных файлах js были определены пути, подходящие для сервера сборки. Для локального файла это означало, что файлы не будут обрабатываться правильно и, следовательно, не будут импортировать ссылки js doc.

Как только я выровнял пути на локальном сервере и сервере сборки, файлы были импортированы правильно, и альт JS doc начал работать нормально.

Doh!