Документирование проектов Node.js [закрыто]

Closed . Этот вопрос основан на мнении . В настоящее время он не принимает ответы.

Хотите улучшить этот вопрос? Обновите вопрос, чтобы на него можно было ответить с помощью фактов и цитат, редактируя это сообщение .

Закрыто в прошлом году .

I ' m в настоящее время использует JSDoc Toolkit для документирования моего кода, но он не совсем подходит, а именно, похоже, он не может правильно описать пространства имен. Допустим, у вас есть два простых класса в каждом из своих файлов:

lib / database / foo.js :

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

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

module.exports = foo;

А затем что-то унаследованное lib / database / bar.js :

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

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

util.inherits(Bar, Foo);

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

В сгенерированная документация выводится просто как Foo и Bar , без ведущей базы данных (или lib.database ), которые являются совершенно необходимо, когда у вас нет всего в глобальной области.

Я пробовал использовать @namespace database и @name database.Foo , но это не так » Получилось хорошо.

Есть идеи, как сделать вывод JSDoc более подходящим, или какой-то совершенно другой инструмент, который лучше работает с Node.js? (Я бегло посмотрел на Natural Docs, JSDuck и пробежался по довольно многим другим, которые выглядели довольно устаревшими ...)

задан Morten Siebuhr 23 May 2011 в 11:39

0 ответов

Другие вопросы по тегам:

documentation node.js code-documentation

Документирование проектов Node.js [закрыто]

0 ответов

Похожие вопросы: