如果不打算使用“return callback（）”作为返回值，我应该记录吗？

Question

我有一段代码没有任何用处：

/**
 * Close the web server
 *
 * @param {function} callback - Called after web server is stopped
 */
PolyApp.prototype.stop = function(callback) {
  if (!this._listeningServer) {
    if (callback) {
      return callback();
    }

    return;
  }

  this._listeningServer.close(callback);
};

此函数使用return来控制执行流程。鉴于它返回没有任何有用的我想避免记录它。这给了我以下好处：

• 文档更清晰，因为它记录了使用意图
• 代码不那么杂乱，没有提供任何价值的评论
• 我避免签署退回我不想维护的合同。

另一方面：

• 我正在返回一个未记录的值

我认为我不应该记录它，因为我不希望人们依赖任何返回的行为。

你怎么看？我做得对吗？

Answer 1

您想要记录的内容取决于您。您必须问自己一个问题：＆＃34;我或其他人是否需要查看此文档以获取其他知识？＆＃34;。如果回调不需要任何特定的退货行为，您就不需要记录任何内容。您应该为 stop 指定它将返回回调的任何内容。否则人们可能会感到困惑。