顶级课程文档

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
       ...

HTH

Answer 2

来自the Rubocop documentation：

  

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

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

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

Answer 3

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

Documentation:
  Enabled: false

.rubocop.yml文件中。