jsduck - sencha フレームワークを使用しないコードのドキュメント化に jsduck を使用できますか?

Question

私は JavaScript ドキュメント ツールを調査しており、JSDuck が印象的であることがわかりました。Appcelerator チタンもそれを使用していることに気付きました。しかし、Sencha の JavaScript フレームワークを使用しないコードを文書化するための使用に関する情報はあまり見つかりませんでした。Javascript コードの文書化にどのように、またどのように使用できるかについての提案はありますか?

Answer 1

JSDuck は、Sencha Ext JS および Touch フレームワークのドキュメント化に重点を置いていますが、プレーンな JavaScript でも問題なく動作します。ExtJS 固有の多くの自動検出機能を利用することはできません。ただし、かなりの量のさまざまな自動検出があります。

たとえば、次の doc-comments@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";