Inspectopedia 2025.2 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

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 ID: MissingYardParamTag

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

Option ID:

myOrder

Default value:

@param [Type] name

Other available settings:

  • @param name [Type]

Suppressing Inspection

You can suppress this inspection by placing the following comment marker before the code fragment where you no longer want messages from this inspection to appear:

//noinspection MissingYardParamTag

More detailed instructions as well as other ways and options that you have can be found in the product documentation:

Inspection Details

By default bundled with:

Qodana for Ruby 2025.2, RubyMine 2025.2,

Last modified: 18 September 2025