jsduck - jsduck 可以用来记录不使用 sencha 框架的代码吗？

Question

我正在探索 JavaScript 文档工具，发现 JSDuck 令人印象深刻。我注意到 appcelerator 钛也使用它。但是，找不到太多关于使用它来记录不使用 Sencha 的 JavaScript 框架的代码的信息。关于如何以及是否可以用于记录任何 Javascript 代码的任何建议？

Answer 1

JSDuck 主要用于记录 Sencha Ext JS 和 Touch 框架，但是，它也适用于纯 JavaScript。您将无法利用许多 ExtJS 特定的自动检测功能。但是你仍然会有相当多的各种自动检测。

例如，以下文档注释不使用任何@class, @method,@property标签 - 所有这些信息和更多信息都是从代码中推断出来的：

/**
 * Docs for my class.
 */
function MyClass {
}
/**
 * Docs for a method.
 * @param {String} p1 ...
 * @param {Number} p2 ...
 * @return {Object}
 */
MyClass.prototype.foo = function(p1, p2) {};
/**
 * Docs for a property.
 */
MyClass.prototype.bar = "Hello";