1. All Inspections
  2. Ruby
  3. YARD
  4. Missing '@param' tag in method parameter

Missing '@param' tag in method parameter

Last modified: 03 December 2024

Reports method parameters without @param tags. A quick-fix is available to add the missing @param tags.

Use the Generated tag format field to specify the format for the added @param tags.

Locating this inspection

By ID

Can be used to locate inspection in e.g. Qodana configuration files, where you can quickly enable or disable it, or adjust its settings.

MissingYardParamTag
Via Settings dialog

Path to the inspection settings via IntelliJ Platform IDE Settings dialog, when you need to adjust inspection settings directly from your IDE.

Settings or Preferences | Editor | Inspections | Ruby | YARD

Inspection options

Here you can find the description of settings available for the Missing '@param' tag in method parameter inspection, and the reference of their default values.

Generated tag format

Default setting: @param [Type] name

Other available settings:

  • @param name [Type]

Inspection Details

By default bundled with:

Qodana for Ruby 2024.3, RubyMine 2024.3,

Can be installed with plugin:

Ruby, 243.23135