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

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

在一个好的代码库中，控制器将非常薄，只处理请求并将所有逻辑委托给模型/服务/助手。因此，一开始就没有太多的文档可供记录。我不是一个API，尤其不是一个开放的API，我认为没有理由向它添加文档

---

希望听听您对此的意见。

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

#:nodoc: all

在你的控制器的顶部，这就是我所做的。这是gem的建议

---

希望这能有所帮助。

我通常至少会为每个操作添加URI/方法。做一个顶级的类描述似乎太棒了，因为它通常很明显是控制器所做的。我知道我可以禁用它，只是想知道我是否应该禁用它。有什么特别的原因你个人认为不需要它吗？正如max所评论的，控制器的功能通常是显而易见的。如果您的控制器所做的不是显而易见的事情，那么顶级文档是很好的。在控制器中编写自定义操作的描述很好。这也是我的想法。很好，谢谢