Question

Reek gem在我的代码中识别出一种气味，使其缺少类中的文档。但我想知道是否应该将它应用于控制器。

在良好的代码库中，控制器非常薄，只需处理请求并将所有逻辑委派给模型/服务/帮助程序。因此，开始记录并不多。不是API，特别是不是开放的API，我没有看到向其添加文档的充分理由。

想听听你对此的看法。

Answer 1

在我看来，控制器中不需要文档。但是如果你想让臭味不能识别这种气味，那么你可以添加控制器的单行说明或添加

#:nodoc: all

在控制器的顶部（这就是我所做的）。这由rubycop gem

建议

希望这有帮助。