Rails 控制器文档是最佳实践吗？

Question

Reek gem 在我的代码中发现了异味，因此它在 类 中缺少文档。但我想知道是否也应该将其应用于控制器。

在一个好的代码库中，控制器会非常薄，只处理请求并将所有逻辑委托给 models/services/helpers。因此，一开始没有太多要记录的内容。不是 API，尤其不是开放的，我看不出有什么理由向它添加文档。

想听听您对此的看法。

Answer 1

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

#:nodoc: all

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

建议

希望对您有所帮助。