Question

我有以下...

/**
 * Represents a base element
 * @extends HTMLElement
 * @constructor
 */
export class Base extends HTMLElement {
...
}

我跑步时...

jsdoc src/jrg-base-element.mjs

然后我得到...

没有要处理的输入文件。

我尝试了--debug并得到了...

{“ env”：{“ conf”：{“ plugins”：[]，“ recurseDepth”：10，“ source”：{“ includePattern”：“。+ \。js（doc | x）？$” ，“ excludePattern”：“（^ | \ / | \\）”}，“ sourceType”：“ module”，“ tags”：{“ allowUnknownTags”：true，“ dictionaries”：[“ jsdoc”，“闭包“]}，”模板“：{” monospaceLinks“：false，” cleverLinks“：false，”默认“：{” outputSourceFiles“：true}}}，” opts“：{” “：[” src / jrg-base-element.mjs“]，” debug“：true，” destination“：” ./ out /“，” encoding“：” utf8“}}}

哪个似乎接近（The error message "There are no input files to process" from jsdoc），但我不知道该怎么办。

有什么想法吗？

Answer 1

我自己尝试过：

安装JSDoc：
```
npm install -g jsdoc => OK
```

创建一个虚拟文件src / x.js：

/**
 * Represents a base element
 * @extends HTMLElement
 * @constructor
 */
function hello () {
  console.log ('Hello world!');
}

运行jsdoc src
检查结果（默认目录"out/"）：

换句话说：

a）您可以指定一个JS文件，但通常会指定一个JS软件包目录。

b）默认情况下，JSDoc无法识别“ .mjs”

建议：

指定配置文件，然后编辑source.includePatter=n：

https://jsdoc.app/about-configuring-jsdoc.html#specifying-input-files

指定输入文件

选项的源集，以及结合给JSDoc的路径   命令行，确定JSDoc用于输入文件的集合   生成文档。
{
    "source": {
        "include": [ /* array of paths to files to generate documentation for */ ],
        "exclude": [ /* array of paths to exclude */ ],
        "includePattern": ".+\\.js(doc|x)?$",
        "excludePattern": "(^|\\/|\\\\)_"
    }
}
source.include ：路径的可选数组，其中包含JSDoc应该为其生成文档的文件。上给JSDoc的路径   命令行与这些路径结合在一起。您可以使用-r   命令行选项以递归到子目录中。

source.exclude ：JSDoc应该忽略的可选路径数组。在JSDoc 3.3.0及更高版本中，此数组可能包含   source.include中的路径。

source.includePattern ：可选字符串，解释为正则表达式。如果存在，则所有文件名都必须与此常规匹配   表达式将由JSDoc处理。默认情况下，此选项设置为   “。+。js（doc | x）？$”，表示仅扩展名为.js的文件，   .jsdoc和.jsx将被处理。

source.excludePattern ：可选字符串，解释为正则表达式。如果存在，则匹配此正则表达式的任何文件   将被忽略。默认情况下，此选项被设置为   以下划线开头（或目录开头的任何内容）   带有下划线的字符）将被忽略。

祝你好运-请发回发现的内容！

JSDoc无法在具有Rollup的.MJS文件中使用

1 个答案: