Class: RuboCop::Cop::Style::DocumentationMethod

Inherits:
Base
  • Object
show all
Includes:
DefNode, DocumentationComment
Defined in:
lib/rubocop/cop/style/documentation_method.rb

Overview

Checks for missing documentation comment for public methods. It can optionally be configured to also require documentation for non-public methods.

NOTE: This cop allows ‘initialize` method because `initialize` is a special method called from `new`. In some programming languages they are called constructor to distinguish it from method.

Examples:


# bad

class Foo
  def bar
    puts baz
  end
end

module Foo
  def bar
    puts baz
  end
end

def foo.bar
  puts baz
end

# good

class Foo
  # Documentation
  def bar
    puts baz
  end
end

module Foo
  # Documentation
  def bar
    puts baz
  end
end

# Documentation
def foo.bar
  puts baz
end

RequireForNonPublicMethods: false (default)

# good
class Foo
  protected
  def do_something
  end
end

class Foo
  private
  def do_something
  end
end

RequireForNonPublicMethods: true

# bad
class Foo
  protected
  def do_something
  end
end

class Foo
  private
  def do_something
  end
end

# good
class Foo
  protected
  # Documentation
  def do_something
  end
end

class Foo
  private
  # Documentation
  def do_something
  end
end

AllowedMethods: [‘method_missing’, ‘respond_to_missing?’]


# good
class Foo
  def method_missing(name, *args)
  end

  def respond_to_missing?(symbol, include_private)
  end
end

Constant Summary collapse

MSG =
'Missing method documentation comment.'

Constants included from VisibilityHelp

VisibilityHelp::VISIBILITY_SCOPES

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, callbacks_needed, #callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

This class inherits a constructor from RuboCop::Cop::Base

Instance Method Details

#modifier_node?(node) ⇒ Object



116
117
118
# File 'lib/rubocop/cop/style/documentation_method.rb', line 116

def_node_matcher :modifier_node?, <<~PATTERN
  (send nil? {:module_function :ruby2_keywords} ...)
PATTERN

#on_def(node) ⇒ Object Also known as: on_defs



120
121
122
123
124
125
# File 'lib/rubocop/cop/style/documentation_method.rb', line 120

def on_def(node)
  return if node.method?(:initialize)

  parent = node.parent
  modifier_node?(parent) ? check(parent) : check(node)
end