Şu anda JSDoc Toolkit kodumu belge için kullanıyorum, ama hiç mantıklı gelmiyor yani düzgün bir şekilde açıklayan bir ad ile mücadele gibi görünüyor. Her dosyalarında: iki basit dersler var ki

lib/database/foo.js:

/** @class */
function Foo(...) {...}

/** @function ... */
Foo.prototype.init(..., cb) { return cb(null, ...); };

module.exports = foo;

Ve sonra bir şey lib/database/bar.js miras:

var Foo = require('./foo');

/**
 * @class
 * @augments Foo
 */
function Bar(....) {...}

util.inherits(Bar, Foo);

Bar.prototype.moreInit(..., cb) { return cb(null, ...); };

Oluşturulan belgeleri, bu çıkış sadece Foo Bar olmadan lider database (lib.database), oldukça gerekli zaman yok her şeyi genel bir kapsam.

Bir de @namespace database @name database.Foo atmayı denedim, ama güzel bir şey çıkmaması.

JSDoc çıkış daha uygun bir şeyler yapmak için herhangi bir fikir, ya da Node.js ile daha iyi çalışır, bu tamamen farklı bir alet mi? (Kısaca Doğal Dokümanlar, JSDuck ve oldukça eski görünüyordu epeyce diğerleri üzerinde breezed...) baktım

JSDoc JavaDoc bir liman. Yani temelde belgelere klasik OOP varsayar ve JavaScript için uygun değil.

Şahsen docco kaynak kodu açıklama için kullanmanızı tavsiye ederim. Bu örnekleri 14*, *, **15 16**için bulunabilir.

Docco için iyi bir alternatif groc

Gerçek bir API belgelerine gelince, ben şahsen yorum otomatik oluşturulan belgeleri sadece sen ve el-yazma API belgelerinize JavaScript tavsiye için çalışmıyor bulmak.

Örnek olacaktır **, , *, *21Express API*20 18*

Benzer StackOverFlow soru

• Generating Javascript documentation