Javascript 为API端点编写有意义的注释

这里不完全是一个编码问题，但我发现很难为我的API端点编写任何有意义的注释

下面是一个例子：

router.get('/courses/:part/modules/:number/:module/sections/:section', 
    isAuthenticated, hasSubscription, (req, res) => {
       render(req, res);
});

如果用户经过身份验证并且拥有正确的订阅，则所有这一切都将呈现一个页面。如果未通过身份验证，则重定向到登录，如果订阅不正确，则重定向到订阅页面。如果两者都正常，则呈现页面

下面是一个POST示例端点：

  module.exports = (app, passport, router) => {

  router.use('/login', (req, res, next) => {
      if (req.user) return res.redirect('/dashboard');
      next();
  });

  router.route('/login').post((req, res, next) => {
    req.assert('email', 'Please sign up with a valid email.').isEmail();
    req.assert('password', 'Password must be at least 4 characters long').len(4);

    var errors = req.validationErrors();
    if (errors) {
      req.flash('errors', errors);
      return res.redirect('/login');
    }

    passport.authenticate('login', {
      successRedirect: req.session.returnURL || '/dashboard',
      failureRedirect: '/login',
      failureFlash : true
    })(req, res, next);
  });
};

---

我真的不知道如何去评论上述内容。我在这里所做的就是首先检查我是否登录，然后使用passport登录用户并相应地重定向。当然，我还在这里验证两个字段：电子邮件和密码，并将错误返回给客户端。

请同事查看您的代码并告诉您它的作用。当这位同事开始提问时，这些是你应该在评论中为后代回答的问题。这个问题属于吗？@nicovank如果作者试图写一些评论，然后要求用代码对评论进行审查，这可能是一个适合代码审查的问题。但是，要求CR写一些不存在的评论是不合适的。@200_这是真的。谢谢你的见解谢谢你的回复，是的，我会和同事们一起回顾这一点，但我恐怕没有任何同事：（这是一个私人项目，我在业余时间在家里做，因此在这里询问社区。）。