-1

我正在为我的一个应用程序路由器在 docblock 下方写信。这样对吗？另外，告诉我每行的含义，因为我不知道。

/** * 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
        });
    }
});

});

4

1 回答 1

0

好的，至于代码上部的注释，它们是docblock文档参数。如果对您有意义，您可以使用像 JSDoc 这样的文档生成器工具来处理 Javascript。

您可以在以下链接中找到 @name、@function 等标签的含义：

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/ 目录中为您的代码文档生成 HTML 文件。打开 out/index.html 以查看文档。

于 2017-12-12T11:52:39.900 回答