nodejs router docblock comment

Question

내 응용 프로그램 라우터 중 하나의 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

정상적으로 코드의 주석 부분은 docblock 문서 매개 변수입니다. Javascript의 경우 JSDoc과 같은 문서 생성 도구를 사용하면 의미가 있습니다.

당신은 아래 링크에서 @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 *.js folder1/*.js folder2/*.js 

이 명령은 HTML을 생성합니다 : 다음

npm install -g jsdoc 

당신이 모든 당신의 js 파일을 나타내는 기본 코드 디렉토리 내부의 명령 줄을 실행 당신이 JSDoc의 NPM 패키지를 설치하기 위해 필요한이 작업을 수행하려면 파일을 out/디렉토리에 코드 문서화. 설명서를 보려면/index.html을 엽니 다.