Rubycop выводит сообщения типа:верхнего уровня
app/controllers/welcome_controller.rb:1:1: C: Missing top-level class documentation comment.
class WelcomeController < ApplicationController
^^^^^
Интересно, какой класс верхнего уровня документации выглядит. Это не просто комментарий, не так ли? Он должен иметь специальный формат, но какой?
RuboCop является рубин статический анализатор кода. Из коробки он будет применять многие из рекомендаций, изложенных в сообществе Ruby Style Guide.
Руководство Стиль Рубина «комментарий» раздел не использует фразу «Missing верхнего уровня класса Комментарий документации», но от чтения раздела руководства по комментариям, вы можете быстро вывести из примеров, комментирующих классы и модули Рекомендовано.
Причина в том, что при использовании rdoc комментарии для классов/модулей будут использованы для создания ссылки на код, что важно, независимо от того, пишете ли вы код для себя, для команды или для общего выпуска другими.
Это говорит простой комментарий, как так будет делать красиво:
# This shiny device polishes bared foos
class FooBarPolisher
...
НТН
Это говорит вам, что вы должны иметь документацию «комментарий» для «класса верхнего уровня», который в этом случае это 'WelcomeController'. Добавьте комментарий над определением класса, чтобы предотвратить это сообщение. Также могут быть другие способы избавиться от этого сообщения. Подробнее см. Документацию по [rubocop] (https://github.com/bbatsov/rubocop/). – vee
@vee Я попытался добавить комментарий ниже определения класса. Благодарю. – DreamWalker
Чтобы преодолеть необходимость добавления реального комментария, вы можете добавить '#: nodoc:' в верхней части файла –