nodejs路由器放映评论

Question

我在下面写下我的应用程序路由器之一。这样对吗？另外，告诉我每行的含义，因为我不确切知道。

/** * Router serving Activity log page. * @name get/activity_log * @function * @memberof module:routers/activity_log * @inner * @param {string} path - Activity log path * @param {callback} middlewear - Express middlewear. */

router.get('/', function(req, res) {
var async = require('async');
var telemetry = require(modulePath)(req.dbquery,req.nosql);
telemetry.getTelemetryLog(function(err, data) {
    console.log(data);
    if(err) {
        res.send(error);
    } else {
        res.render('_admin/activity_log', {
            title: 'App Admin',
            username: req.session.user.name,
            notifications: req.session.notifications,
            tasks: req.session.tasks,
            telemetry: data
        });
    }
});

}）;

Answer 1

好的，对于代码上部的注释，它们是DocBlock文档参数。如果对您有意义，则可以使用JSDOC这样的文档生成器工具。

您可以在下面的链接中找到标签的含义：

http://usejsdoc.org/tags-name.html

http://usejsdoc.org/tags-function.html

http://usejsdoc.org/tags-inner.html

http://usejsdoc.org/tags-param.html

等等。

在所有代码或至少有这样的零件之后，您可以生成HTML内容以清楚地浏览文档使用超链接。为此，您需要安装JSDOC NPM软件包：

npm install -g jsdoc

然后，您在主代码目录中运行命令行，指示所有JS文件：

jsdoc *.js folder1/*.js folder2/*.js

此命令将在OUT/Directory中为您的代码文档生成HTML文件。打开/index.html查看文档。