Inspectopedia Help

Missing '@param' tag in method parameter

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


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

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]


By default bundled with

Qodana for Ruby 2024.1, RubyMine 2024.1,

Can be installed with plugin

Ruby, 241.SNAPSHOT

Last modified: 18 June 2024