顶级课程文档

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

从Rubocop文档:

RuboCop是一个Ruby静态代码分析器.开箱即用它将强制执行社区Ruby样式指南中列出的许多指导原则.

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

原因是,在使用时rdoc,类/模块的注释将用于生成对代码的引用,无论您是为自己编写代码,为团队编写代码还是由其他人进行一般性发布,这都是非常重要的.

Answer 3

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

Documentation:
  Enabled: false

在您的 .rubocop.yml 文件中。