记录代码

YARD 和 RDoc 是用于记录代码的多个库中最流行的文档生成工具。 RubyMine 允许您使用快速文档查找功能以 YARD 或 RDoc 语法查看文档。此外，RubyMine 提供了扩展功能以处理 YARD 标签：

创建和修复 YARD 标签

在这里，我们将向您展示如何记录一个带有多个参数的方法。在我们的示例中，该方法接受两个参数并返回这些值的乘积。

                def multiply(val1, val2)
                end

我们将了解如何使用 YARD 标签注释此方法并修复不正确的标签。

将插入符号放在方法名称处并按下 Alt+Enter。
在弹出的窗口中，选择添加 @param 标签操作。
RubyMine 将在方法上方添加相应的注释，并建议您指定每个参数值的类型。开始输入 Integer ，然后按 Ctrl+Space 查看建议。选择整数，按 Enter 确认您的选择，然后再次按 Enter 以指定第二个参数的类型。

默认情况下，RubyMine 在参数类型之后生成参数名称（例如， @param [Integer] val1）。要更改此行为并在参数类型之前设置参数名称（@param val1 [Integer] ），请执行以下操作：

当您编辑 YARD 标签时，RubyMine 会检查是否存在任何错误的标签。例如，这可能是一个重复的标签或代码中没有对应参数的标签。要移除不正确的 YARD 标签：

RubyMine 利用 YARD 类型注解来实现各种代码洞察功能，例如，确定对象类型、在代码补全中使用获取的对象类型、查看方法的参数信息等。让我们来看几个示例。

RubyMine 使用诸如 @return、 @param 或 @yieldparam 的 YARD 标签来确定对象类型。

请注意，RubyMine 会建议与指定类型相对应的补全结果。

RubyMine 可以检查方法的实际返回值和参数类型是否与通过 @return 和 @param 注解提供的对应类型匹配。例如，如果方法的返回值类型与 @return 类型不匹配，编辑器会向您显示警告。

您可以使用参数类型不匹配和返回类型不匹配检查来管理这些警告。

RubyMine 能识别 @overload 标签，并在显示参数信息时向您建议所有已声明的重载。

除了标准的 YARD 和 RDoc 标签，RubyMine 还可以处理 @type 标签以获取变量类型的信息。例如，您可以将此标签用于局部变量（无论是否带有变量名）和块参数：

局部变量
# @type [Integer] customer_id = 1 # @type [String] customer_name customer_name = "Andrew Fuller"
块参数
# @type [Integer] number [1, 2, 3].each do |number| puts "#{number}" end