nodejsルータdocblockコメント

Question

私は自分のアプリケーションルータの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 
     }); 
    } 
}); 

}）。

Answer 1

OKのコードの上部のコメントは、docblockのドキュメントパラメータです。 Javascriptの場合は、JSDocのようなドキュメント生成ツールを使用することができます。

あなたは以下のリンクで@name、@関数、および他のようなタグの意味を見つけることができますので、

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コンテンツを生成できます。そして、あなたはすべてのあなたのjsファイルを示すメインコードディレクトリ内のコマンドラインを実行

npm install -g jsdoc 

：

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

このコマンドは、HTMLを生成します。あなたはJSDocのNPMパッケージをインストールする必要があります。これを行うために あなたのためのファイルはout /ディレクトリのドキュメントをコード化します。 ドキュメントを表示するには、/ index.htmlを開きます。