在 JSDoc 中记录开放式参数函数的正确方法
假设您有如下内容： var someFunc = function() { // do something here with arguments } 您如何正确记录该函数可以在 JSDoc 中接受任意数量的参数？…
jQuery 兼容的 JavaScript 文档生成器
我需要为我的 javascript 项目选择一个文档生成器（类似于 java 中的 jdoc 或 ruby 中的 rdoc）（使用 jquery、下划线和主干构建） 候选： jsdoc …
为什么 jQuery 不使用 JSDoc？
Closed. This question is opinion-based. It is not currently accepting answers. 想要改进这个问题？更新问题，以便可以通过编辑这篇文章用事实和…
如何在 jsdoc-toolkit 中包含已经记录的方法？
我有一个使用闭包方法创建的 JavaScript 单例对象： /** * This is the singleton. * * @namespace window.Something.Singleton */ window.Something.…
在 reStructuredText 中插入相对链接
我正在记录一个包含 Python 组件和 JavaScript 组件的库。整个用户文档和 Python API 文档位于 reStructuredText 中，并使用 Sphinx 进行处理。 JavaS…
如何记录可变数量的参数
如何记录可变数量的参数？我正在用 PHP 和 JavaScript 编写一个应用程序。目前我有（在 JavaScript 中）： /** * Description * @param {String} desc…
Javadoc Jsdoc 在 @param 和 @return 内容块之后写一些东西？
你知道是否可以在@param和@return块之后写一些东西。 假设我想在参数/返回声明之后编写一段文本，与它们分开。 看来 Javadoc 和 Jsdoc 都将您在 @para…
JSDoc 在文档中添加真实代码
你知道 JSDoc 中是否有某种 标签吗？我需要在我的文档中添加如下代码： /** * This function does something see example below: * * var x = foo("te…
如何在 JSDoc 中记录事件处理程序？
假设我有一个这样的类： function myClass(q) { this.someFunction = function(e) { console.log("Click event"); }; jQuery(q).click(this.someFunct…
将 JSDoc 与命名空间和函数定义的变体形式一起使用
我一直在尝试使用 JsDoc 来记录我的 javascript，但我不断遇到这个障碍。 它一直说“没有什么可记录的，正在退出” 这是我试图记录的代码： /** * Con…
jsdoc/tsdoc 在有多个重载方法时应该把注释写在哪个方法上？
TypeScript 代码中，一个函数有多个重载，但仅打算写一个函数注释时，应该写在哪个方法上？例如：function merge(x: T, y: T): T & U; function merge…
