Python
Java
PHP
IOS
Android
Nodejs
JavaScript
Html5
Windows
Ubuntu
Linux
有没有用 Javascript 编写的开源 JSDoc 解析器?
我正在寻找一个可以在我的项目中使用的 JSDoc 解析器 我正在寻找可以传递 JSDoc 注释并接收该注释含义的结构化描述的东西 我见过的大多数工具似乎都能够将 JSDoc 注释转换为 HTML 或其他格式 我正在寻找能够提供可用于输入其他
javascript
jsdoc
是否可以告诉 jsdoc 在与源代码分开的文件中查找该代码的文档?
我希望内联注释尽可能短 因为我的经验是超过 3 或 4 行的注释往往会被掩盖 从而产生很多不必要的 阅读手册行 遗留系统要求我遵守与 jsdoc 兼容的格式来记录代码 如果要正确记录许多不言而喻的事情 则需要明确声明它们 实际上每个标签都可
javascript
documentationgeneration
jsdoc
JSDoc 这就是将 @typedef 标记为 @global 的方式吗?
只需确保在我们的节点服务器的模块中这是能够使用的正确方法 typedef整个应用程序 而不是在每个需要的模块 文件中重复它 从文档中我无法确定这是否正确 并且是否有人对存储全局 typedefs 有意见 以便在整个应用程序中使用时很容易找到
javascript
jsdoc
jsdoc3
寻求:如何将 jsDoc 与 Webstorm IDE 一起使用的示例 (v 4)
我仍在学习 js 并尝试 Webstorm IDE 这看起来很不错 包括跳转到 var function 声明 我可以看到如何获取 jsdoc 评论的模板 但我对此没有经验 并且正在寻找如何在评论中提供更多详细信息以及如何提供的示例view
jsdoc
webstorm
如何在 Visual Studio Code 中的事件上使用 JSDoc 自定义 EventEmitter?
我一直致力于 Node js 项目 只是注意到 Visual Studio Code 提供了有关基本 EventEmitter 对象的信息 所以我想也应该可以为自定义提供 JSDoc 我已经尝试遵循 JSDochttp usejsdoc o
nodejs
VisualStudioCode
jsdoc
EventEmitter
es6class
请参阅在 JSDoc 中键入不同的文件而不导入
我正在 Visual Studio Code 中编写 JavaScript ES6 代码 并启用 VSCode 的类型检查 如VSCode 文档 https code visualstudio com docs languages java
javascript
VisualStudioCode
jsdoc
JSDOC:如何记录函数的内部变量
有没有办法让 JSDOC 显示函数内部的变量而不使用 命名空间函数前面的注释 我做了一个小测试对象 但它只会显示内部变量k对于最后一个函数 它被声明为命名空间 我想使用 成员 注释和精确 name注释将在下面调用的第二个方法中显示内部变量d
jsdoc
jsdoc3
将 JsDoc3 用于大型应用程序,如何将模块分组为部分/类别/子模块
我正在开发一个应用程序 随着时间的推移 它会变得相当庞大 我决定使用JsDoc3 and DocStrap记录所有模块 模块是通过 require js 定义的 在某些地方它们的嵌套深度可达 3 或 4 层 到目前为止 我了解到 JsDoc
javascript
Documentation
jsdoc
jsdoc3
JSDoc 中的 Intellisense 不适用于 VSCode 中的导入类型
当使用 ES2015 类作为 JSDoc 中的类型时 它在通过 require 语句导入该类的文件中似乎无法正常工作 在定义该类的同一文件中工作时 一切都按预期工作 如下所示 在不同的文件中工作时 该类似乎可以正确导入并显示其构造函数类型
javascript
IntelliSense
VisualStudioCode
jsdoc
如何使用 JSDoc Typescript 声明隐藏“私有”方法?
假设我有一个 JavaScript 类 element my element export class MyElement extends HTMLElement publicMethod private privateMethod cus
javascript
typescript
private
jsdoc
dts
JSDoc 和 JavaScript 单例文档
我有一个 JavaScript 单例定义为 A description here class com mydomain ClassName function constructor lends com mydomain ClassName
javascript
jsdoc
TypeScript 到 JSDoc:全局/接口
我目前正在使用 JSDoc 将项目从 TypeScript 转换为 JavaScript 我正在尝试使用 JSDoc 执行以下操作 declare global namespace jest interface Matchers
typescript
jsdoc
JSDoc - 如何记录原型方法
我一直在尝试使用 JSDoc 记录以下代码 module person A human being class param string name function Person name this name name Person pro
javascript
documentationgeneration
jsdoc
codedocumentation
jsdoc3
注释中带有 Immutable.js 数据结构的 JSDoc
我正在返回 Immutable jsList https facebook github io immutable js docs List来自函数的数据结构 PHPStorm 会自动附加以下内容 returns List
javascript
jsdoc
immutablejs
如何将JsDoc变成“混合”类型?
简单的问题 如何记录 混合类型 我知道我可以列出所有可能的类型 例如 null undefined String Number Object 最终发现自己错过了一个并使其变得过于复杂 我尝试使用 Mixed 关键字 但它在许多 IDE 例如
parameters
mixed
jsdoc
jsdoc二维数组
我有一个字符串数组的数组 但我不知道如何使用 JSDoc 来记录它 class function PostbackList type int default this TypeID 0 type PostbackList Field thi
javascript
jsdoc
jsdoc3
如何使用 JSDoc 记录 ECMA6 类?
背景 我在 Nodejs 中有一个使用 ECMA6 类的项目 我正在使用JSDoc http usejsdoc org 评论我的代码 以便其他开发人员更容易访问它 然而 我的评论并没有被该工具很好地接受 而且我的文档也很糟糕 Problem
javascript
nodejs
Documentation
jsdoc
如何将 jsdoc 参数传递给 Web 请求?
我有这样的功能 在 Node js Firebase 中 并且想知道如何添加 JSDoc 格式的文档 exports getUserRes functions https onRequest async request response g
nodejs
firebase
jsdoc
如何在 JSDOC 中记录对象数组
我有一个以对象数组作为参数的函数 并且想使用 JSDOC 描述参数 包括数组中对象的属性 如下例所示 param Array filter array of filter objects param function doSomething
javascript
jsdoc
jsdoc3
JsDoc命名空间
我正在使用 JsDoc 编辑 js 文件以获得干净的文档 我的结构非常简单 Finds an object param string prop Property Array prototype findObject function fin
javascript
Documentation
jsdoc
1
2
3
»