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";

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

1 个答案: