如何使用JSDoc类型脚本声明隐藏私有方法？
假设我有一个JavaScript类 /** * @element my-element */ export class MyElement extends HTMLElement { publicMethod() {} /** @private */ privateMethod() {} } customElements.define('my-element', MyEle
..
jsdoc相关内容
JsDoc-设置类型而不导入文件
我在VScode中使用角度1。我有一个主文件，它定义了我的所有服务、控制器等，并且require它们的角度。 angular.module('myApp', []) .service('myService', require('./myService.js') .controller('myController', require('./myController.js');
..
是否在VSCode中的`exports.default`上损坏了JSDoc？
我对VSCode和JSDocs有一种非常奇怪的体验。 显示命名导出的JSDocs信息，但不显示使用commonJS导出方法的默认导出的JSDocs信息。 问题：exports.default 没有弹出信息 文件：index.js /** * Some explanation * * @param {object} obj The obj has to be~~~ !
..
枚举作为 JSDoc 中的 @param 类型
是否可以像下面的示例一样为 JSDoc @param 类型声明使用枚举? /*** @enum { 数字 }*/变种类型 = {TYPE_A:1，TYPE_B:2}/*** @param { 类型 } 类型*/函数 useTypesEnum( 类型 ) {} 如果我对 JavaScript 使用 Eclipse 等 IDE，应该不会发出警告? 解决方案 JsDoc 注释对 JavaSc
..
使用 jsdoc 记录匿名对象和函数的最佳方式
编辑:从技术上讲，这是一个两部分的问题.我选择了涵盖一般问题的最佳答案，并链接到处理特定问题的答案. 用 jsdoc 记录匿名对象和函数的最佳方法是什么? /*** @class {Page} 页面类规范*/var 页面 = 函数() {/*** 从服务器获取页面* @param {PageRequest} pageRequest 您要请求的页面上的信息* @param {function
..
如何 jsdoc 注释 BackboneJS 代码?
有没有人用 JSDoc 记录过 BackboneJS 代码? 我在注释 Backbone 结构时遇到问题，例如: User = Backbone.Model.extend({默认值:{ a: 1 },初始化:函数(){//...},做某事:功能(p){//...}}); 任何建议表示赞赏.谢谢. 解决方案 我认为它的工作原理是这样的，如果你在谈论 JSDoc 工具包: User
..
Google Sheets 自定义函数支持多少 JsDoc?
Google 暗示支持 JsDoc: 如果自定义函数的脚本包含JsDoc @customfunction 标记，如下面的 DOUBLE() 示例所示. https://developers.google.com/apps-script/guides/工作表/功能 但似乎没有完全支持 JsDoc，而且我找不到显示支持和不支持的文档. 我特别在寻找一种方法来记录自定义函数的参数
..
如何让 VS Code 跨多个文件理解 JSDOC 的 @typedef
我想在一个文件中指定一种类型，并能够在另一个文件中重用它.我试过 modules 但它在 VS Code 中不起作用.还有其他解决方案吗?只是想让我的项目的所有类型都可以重用，这样我就可以跨文件在不同的函数中引用它们.这是我找到的最接近的问题. 解决方案 我使用 jsconfig.json 及其 include 属性在 Visual Studio Code 1.33.1 的普通 JavaS
..
如何使用 JSDoc3 记录 AMD + Backbone 项目
我有一个基于 Backbone 样板 的项目，我想用最近的 jdoc-toolkit 虽然除了空的 _global 类之外我无法让它生成任何东西 代码示例: /*** 这是 DLClass 的根模型* @module 模型/DLClass*/定义(['下划线','骨干'],/** @lends DLClass */function (_, Backbone) {/*** 这是 DLC
..
如何使用 jsdoc-toolkit 记录匿名函数(闭包)
我正在尝试使用 JSDoc-toolkit 来记录我的代码.我的代码首先被一个自动执行的匿名函数包装起来.我到底如何记录这个?我几乎花了一整天的时间在这上面.JS Docs 不会识别匿名函数闭包中的任何内容，因为它不知道如何处理它.它打破了，我的评论都没有通过. 我的代码看起来像这样. /*** @fileoverview BLA BLA BLA*//*** 这是我不知道该放什么的地方.*
..
将流类型包含到 JSDoc 中
我一直在阅读 github 上的一些问题和projects 建立在 Flow 之上，用于在 Flow 和 JSDoc 之间创建“桥梁"，或者简单地从 Flow 类型注释生成 JSDoc. 他们都没有回答我这个“简单"的需求: 问:如何在 JSDoc 中包含 Flow 类型? 我不想摆脱 JSDoc 注释块，因为它们不仅用于类型检查，还用于文档和向他人或未来的自己解释代码. 我想
..
带有 AngularJS 的 JSDoc
目前在我的项目中，我们正在使用 JSDoc，我们最近开始实施 Angular，我想继续使用 JSDoc 以确保所有文档都在同一个地方. 我看了一些人，主要只是说要使用 ngDoc，但这并不是一个真正可行的选择，因为我们总是有单独的 JavaScript，理想情况下我会把所有东西放在一起. /*** @author 示例 * @copyright 2
..
如何让jsDoc“导入"使用 vscode?
我想用@import 导入一个节点模块，但似乎visual studio 代码没有得到它.还是我做错了? 解决方案 我个人建议 TypeScript 而不是 JSDoc. 尽管如此，尝试这样的事情?(JSDoc 中没有 @import 标签). //path/to/UiStore.js/*** @typedef UiStore* @type {对象}* @property {str
..
vs 代码智能感知不适用于 webpack 包
我有一个简单的 webpack 配置. const path = require('path');模块.出口 = {开发工具:'源地图'，条目:'./src/index.js',输出: {libraryTarget: 'commonjs',文件名:'index.js',路径:path.resolve(__dirname, 'dist'),},}; 在我构建并将我的模块上传到 npm 并将它们用
..
如何在评论/JSDoc 中引用另一种打字稿类型?
我熟悉 Javadoc.在 Javadoc 中，您可以放置一个链接，该链接指向放置在另一种类型上的 Javadoc 像这样: /*** 一些 Java 的东西.也看到这个其他的 java 东西 {@link OtherThingy}*/公共类Thingy {/*...*/}/*** 一些其他的 Java 东西.也看到第一个 java 东西 {@link Thingy}*/公共类 OtherT
..
参考在 JSDoc 中输入不同的文件而不导入
我正在 Visual Studio Code 中编写 JavaScript (ES6) 代码并启用 VSCode 的类型检查，如 VSCode 文档. 当引用在另一个文件中定义的类型(下面示例中的 Track)时，我收到类似 [js] 找不到名称 'Track' 的错误在 JSDoc 引用该类型，除非我导入它.当我导入这个类型时，我从 ESLint 得到一个错误:[eslint] 'Trac
..
如何在vscode中使用jsdoc在包装函数中正确获取返回值的推断类型?
这里有一些代码(简体)可以更好地理解: 用于发送请求的包装器 发送请求和完成请求时，它会做一些常见的事情. 它返回请求的结果(处理程序). 异步函数请求(处理程序){//常见的东西尝试 {const结果=等待处理程序()返回结果||真的}抓(err){doSomethingWithError(err)返回错误}最后 {//常见的东西}}/***想象一个简单的服务/API客户端*
..
JSDOC:如何记录函数的内部变量
有没有一种方法可以使JSDOC在函数内部显示变量而无需在函数之前使用 @namespace 批注? 我做了一个小的测试对象，但是它只会显示最后一个函数的内部变量 k ，该函数被声明为名称空间.我认为使用 @memberof！批注和精确的 @name 批注将在下面称为 diff 的第二种方法中显示内部变量.我正在使用-access"all" --explain 选项在命令上运行jsdoc3.
..
星号是否对“有效"有效?JSDoc?
我总是看过以下格式的JSDoc(及其之前的JavaDoc): /***这是一些JSDoc ...* ...还有更多*/函数foo(){ 但是，我的一位同事不希望没有星号，即: /**这是一些JSDoc ......还有更多*/函数foo(){ 当我在Eclipse中尝试此操作时，它仍会将代码识别为JSDoc(它的颜色与非JSDoc注释的颜色不同).但是，当我查看JSDoc网站时，所有示
..
JSDoc可以记录动态生成的方法吗?
这是构造函数 A ，它为实例提供2种方法: printThing 和 printBall .我使用 JSDoc 来记录这样的方法: var A = function(){/***打印“东西"* @param {Number} N-要打印的次数.*/this.printThing =函数(N){var i = 0;而(i
..