Документация по функциям JavaScript - PullRequest
0 голосов
/ 29 ноября 2018

оповещение новичка !!

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

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.
 */ 

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

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

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

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

module.exports.funcName = funcName;

Кто-нибудь?

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

1 Ответ

0 голосов
/ 08 апреля 2019

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

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

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

Дох!

...