ruby - 顶级类文档

Question

Rubycop 输出如下消息：

app/controllers/welcome_controller.rb:1:1: C: Missing top-level class documentation comment.
class WelcomeController < ApplicationController
^^^^^

我想知道顶级类文档是什么样的。这不仅仅是评论，是吗？它需要有一种特殊的格式，但是是哪一种呢？

Answer 1

也就是说，像这样的简单评论会很好：

# This shiny device polishes bared foos
class FooBarPolisher
       ...

Answer 2

从Rubocop 文档：

RuboCop 是一个 Ruby 静态代码分析器。开箱即用，它将强制执行社区Ruby Style Guide中概述的许多准则。

Ruby 样式指南的“注释”部分没有使用“缺少顶级类文档注释”这一短语，但通过阅读关于注释的指南部分，您可以从示例中快速推断出建议使用注释类和模块。

原因是，在使用 时rdoc，类/模块的注释将用于生成对代码的引用，无论您是为自己编写代码，还是为团队编写代码，还是为他人的一般发布编写代码，这一点都很重要。

Answer 3

我最终在这里寻找一种禁用此检查的方法，如果这是您的情况，请输入

Documentation:
  Enabled: false

在你的.rubocop.yml文件中。