Jsdoc不排除路径

文章/答案/技术大牛

发布

1回答

javascript、jsdoc

我使用的是Jsdoc 3.6.2。$", } 当我在MyProj目录上执行jsdoc -r -c pathToMy/conf.json时，Jsdoc没有排除'excludeFolder‘文件夹。Jsdoc全局安装在C:/Users/myUser/appData/Roaming/npm上。

浏览 17提问于2019-05-13得票数 0

1回答

JSDoc没有在.MJS文件中使用汇总

ecmascript-6、jsdoc、jsdoc3

jsdoc src/jrg-base-element.mjs没有要处理的输入文件。我试过--debug .$”，“excludePattern”：“(^\)”}，“sourceType”：“模块”，“标记”：{“allowUnknownTags”：true，“字典”：“jsdoc”，“闭包”}，“模板”：{

浏览 6提问于2019-12-07得票数 1

回答已采纳

2回答

将@property设为私有

javascript、documentation、jsdoc

我正在使用我希望能够生成两次文档，一次列出私有属性，另一次不列出私有属性。

浏览 8提问于2013-05-08得票数 1

1回答

伊斯坦布尔ignore next也忽略jsdoc

javascript、jestjs、jsdoc

我有一个场景，其中我有一个函数，我们不想将它包含在Jest测试覆盖范围中，但我们仍然希望将它包含在JSDoc文档生成中。next */ console.log("testing");}; 我希望该函数不包含在Jest代码覆盖率统计信息中，但我仍然希望处理该JSDoc并将其包含在通过JSDoc生成的文档中。有没有其他方法可以告诉Jest排除这个方法？

浏览 17提问于2020-11-09得票数 1

1回答

jsDoc -不排除标记为@private的方法

javascript、jsdoc

目前，jsDoc正在排除标记为@private的类方法，这反过来又不会为这些方法生成文档。我们的文档只在内部使用，所以我仍然希望显示这些方法，这样其他开发人员就知道了。我是否可以只向jsdoc.json文件添加属性，以仍然显示方法、属性等...不管是否标记为“私有”？

浏览 10提问于2021-03-03得票数 0

回答已采纳

1回答

如何在IDEA / WebStorm中生成一个WebStorm文档？

intellij-idea、webstorm、jsdoc

在IDEA / WebStorm中只需一次单击就可以生成一个JavaDoc文档，就像我用IntelliJ IDEA做JavaDoc一样。

浏览 2提问于2020-09-25得票数 3

回答已采纳

1回答

jsdoc问题:显示源文件的完整路径(意外)

javascript、macos、terminal、jsdoc、jsdoc3

我在我的项目中使用了jsdoc3，一切都编译得很好。但是这两天我一直在摆弄这个，我放弃了：示例：我不喜欢它显示我的完整本地路径.../jsdoc-master/jsdoc js/jsfile.jscd /

浏览 1提问于2014-02-28得票数 1

1回答

JSDoc注释没有显示在绝对路径导入上

javascript、import、visual-studio-code、jsdoc

我正在添加JSDoc函数文档，在导入具有绝对页面路径的函数时，很难将文档注释显示出来。JSDoc函数：* Adds two numbers together and returns that value* @param {number}returns the value of a plus bfunction addNums (a, b) {} 与相对页路径一起工作

浏览 2提问于2020-01-15得票数 1

回答已采纳

1回答

无法使eslint对Ember类、道具、操作中没有jsDoc发出警告

javascript、ember.js、eslint、jsdoc

'jsdoc/check-examples': 0, 'jsdoc/check-tag-names': 1, 'jsdoc/newline-after-description': 1, 'jsdoc&#x

浏览 0提问于2019-02-21得票数 1

2回答

JSDoc注释中的JSDoc注释

javascript、comments、jsdoc

我给出了带有JSDoc注释的代码示例，这些注释也包含JSDoc注释，如何在不破坏外部注释的情况下转义嵌套的JSDoc注释？额外的空间将阻止这个* /或*\/，然后-当然-显示在JSDoc文档中，这是我不想要的。有没有办法避免这种情况，这样生成的JSDoc看起来就像正确的代码？

浏览 5提问于2015-03-30得票数 3

1回答

如何在带有点号的模块上使用JSDoc类型推断？(Discord.js)

ecmascript-6、webstorm、node-modules、jetbrains-ide、discord.js

我正试图找到一种方法，使用WebStorm的Discord.js TypeScript类型推断，在一种不冲突的模式下处理TypeScript注释。我还尝试了module:discord\.js、module:'discord\.js'和双引号，结果都是一样的。我知道在JSDoc路径名中使用一个点有点麻烦，而且JetBrains使用的闭包编译器在JSDoc遵从性上可能不会达到100%。

浏览 2提问于2018-08-10得票数 0

回答已采纳

1回答

如何包含和排除用于使用documentationjs进行解析的目录

documentation、glob、jsdoc、documentation-generation、documentationjs

特别是，我对排除任何node_modules文件夹感兴趣，但还有其他文件夹需要排除。这通常是在配置文件中完成的；例如，.jsdoc文件，如下所示： "include" : ["..

浏览 16提问于2018-02-07得票数 1

1回答

在模块中为私有(非导出)函数生成JSDoc文档

javascript、jsdoc

我正在使用JSDoc生成器为我的项目生成一些好看的文档，其中我正在使用AMD模块。在我的项目中，我有一些模块包含未导出的函数，因此不能从模块外部使用它们。在生成JSDoc时，这些函数不包含在文档中。

浏览 2提问于2015-11-24得票数 2

回答已采纳

1回答

gulp监视文件更新jsdoc

javascript、gulp、jsdoc3

我正在尝试查看一个目录中的一些文件，并使用jsdoc自动更新那里的文档。我使用gulp查看文件并运行jsdoc，参见下面的代码。const gulp = require('gulp');const jsdoc = require('gulp-jsdoc3/jsdoc.json'); return watch(['..它不会更新我的jsdoc

浏览 31提问于2018-06-02得票数 0

回答已采纳

3回答

没有Java的JSDoc？

node.js、npm、gruntjs、jsdoc

Jsdoc requires Java to run.我知道JSDoc是基于Java的，但我希望将Java从等式中完全删除。

浏览 10提问于2013-08-05得票数 5

回答已采纳

2回答

如何省略JsDoc中的源链接？

jsdoc、jsdoc3

导致JsDoc删除源链接的最简单方法是什么？我必须定义我自己的模板吗？

浏览 2提问于2014-01-03得票数 20

回答已采纳

1回答

JS单据注释链接方法

javascript、jsdoc

在JavaScript注释中，我想提到某个文件中存在方法。如何在注释中链接到该方法？例如：function xyz() {假设我正在写一条评论，像这样{method-link}应该是什么？

浏览 3提问于2017-11-03得票数 9

2回答

如何为SAHI脚本生成Javadoc风格的文档？

javascript、java、documentation、javadoc、sahi

我使用sahi-script编写了我的所有测试，因为这是使用这个工具的推荐方法：。>javadoc baum.sah>javadoc warning: No source files for package baum.sah >Cons

浏览 7提问于2015-12-11得票数 0

回答已采纳

2回答

从jsDoc输出中排除外部变量

node.js、jsdoc

如何从jsDoc输出中正确排除Externals部分？我在我的项目中有很多外部的东西，我根本不想在导航面板上显示，因为它占用了所有的空间，对我们来说是无用的。我已经能够通过更改文件node_modules\jsdoc\lib\util\templateHelper.js中的代码来手动破解它，但对于我的开发团队来说，这不是一种可重用的方法。

浏览 21提问于2017-03-12得票数 1

回答已采纳

2回答

如何在ubuntu中的整个目录上运行jsdoc

jsdoc、jsdoc3

我只需在包含.js文件的ai整个目录上运行jsdoc，我将通过发出命令jsdoc abc.js对ubuntu终端中的单个文件执行jsdoc命令，但我需要的是一次对目录中的所有文件应用此命令，以便该目录中包含

浏览 3提问于2016-11-01得票数 14

点击加载更多