Vim JSDoc、PHPDoc、JavaDoc、RDoc 信息
事情是这样的, 如果您使用过 Aptana、Eclipse 甚至 Microsoft Expression Web 编辑器,那么您会发现它们具有显示提示的气球文本或Intellisense 弹出…
在 JavaScript 中为 Google Closure 编译器注释 Singleton 对象,或“危险使用全局 this 对象”警告
我正在 ADVANCED_OPTIMIZATIONS 编译级别使用 Google Closure 编译器,并开始注释我的构造函数,因为我收到了各种警告: 警告 - 全局 this 对象的危险…
jQuery(document).ready() 内的 JSDoc 兼容性
我在 jQuery(document).ready(function {}) 中声明了一些函数,并且我已经向它们编写了 JSDoc 注释。问题是,当我专注于函数调用行时,它们无法显示为…
JSDoc-toolkit 中的自定义标签
你好 我正在尝试将自定义标签添加到 JSDoc-toolkit。我发现的唯一有用的网站是:使用自定义标签,但它不起作用。 我也尝试了 {+data.comment.getTag("…
如何将 JsDoc 进行“混合”类型?
简单的问题,如何记录“混合类型”?我知道我可以列出所有可能的类型,例如 {null|undefined|String|Number|Object} ,最终发现自己缺少一种类型并使…
如何实现 JsDoc 多重继承或 mixins?
如何记录 mixin 或多重继承? /** * @class Parent */ function Parent() { } Parent.prototype.parentTest = 5; /** * @class Mixin */ function Mix…
JsDoc中如何返回void?
JsDoc中是否有指定的方法或函数声明返回void?目前我认为 void 是默认返回值,其他返回值必须特别提供: /** * @return {Integer} The identifier for…
在 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…