JSDo c комментарии не отображаются при импорте по абсолютному пути - PullRequest
Новая
       19

JSDo c комментарии не отображаются при импорте по абсолютному пути

1 голос
/ 15 января 2020

Я добавляю документацию по функциям JSDo c и у меня возникают проблемы с отображением комментариев к документации при импорте функций с абсолютным путем страницы.

Функция JSDo c: 

/**
* Adds two numbers together and returns that value
* @param {number} a
* @param {number} b
* @return {number} returns the value of a plus b
*/
function addNums (a, b) {
 return a + b;
}

export { addNums }

Работает с относительным путем страницы:

import { addNums } from './addNums'

Не работает с абсолютным путем страницы:

import { addNums } from '~/lib/helpers/addNums'

Экран снимки того, как это выглядит, когда я изменяю путь с абсолютного на относительный в моем фактическом коде:

Абсолютный путь к странице: Absolute page path Относительная страница путь: Relative page path Я пробовал решение, указанное в этой теме SO: Как мне заставить VSCode распознавать текущий пакет Javascript импорт?

К сожалению, это не сработало, поэтому мне интересно, как заставить JSDo c распознавать мои абсолютные пути страниц, а не относительные пути страниц, которые я определяю при импорте. Спасибо!

1 Ответ

0 голосов
/ 16 января 2020

Разобрался. Так что это была проблема с тем, как мы настроили наш веб-пакет для распознавания ~

//webpack config

     config.resolve.alias = {
      ...config.resolve.alias,
      '~': path.resolve(__dirname)
    }

. Я считаю, что обычно у JSdo c нет проблем с разрешением абсолютных путей к файлам, но в моем случае я добавил файл tsconfig. json: 

   ///tsconfig.json

   {
    "compilerOptions": {
        "allowJs": true,
        "baseUrl": ".",
        "paths": {
            "~/*": ["*"]
        }
    }
}

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

...