如何为动态定义的String方法添加文档与RBS类型签名？

针对你动态给String类添加方法后，同时需要文档支持和类型签名的需求，推荐两种可行的处理方式：

方案一：同时使用YARD @!method + RBS定义 #

这种方式能同时满足文档生成、代码补全和类型检查的需求：

1. 用YARD @!method编写文档 #

即使方法是动态生成的，YARD的@!method声明式标签可以直接在类的空定义里添加，工具（包括RubyMine）能识别这些标签提供补全，YARD也能据此生成完整文档。示例：

# @!method my_dynamic_method(arg1: String) -> Integer
#   动态生成的字符串处理方法，根据配置加载逻辑
#   @param arg1 [String] 辅助处理的输入参数
#   @return [Integer] 返回处理后的数值结果
class String; end

这里要保证标签里的方法名、参数、返回值和实际动态生成的方法完全一致。

2. 编写RBS类型签名 #

在项目的RBS目录（比如sig/）下创建string.rbs文件，添加对应方法的类型签名，同时可以补充注释（目前RubyMine对RBS的注释高亮和补全支持正在完善）：

class String
  # 动态加载的字符串处理方法，用于XXX场景
  def my_dynamic_method: (arg1: String) -> Integer
end

如果是批量生成的方法，可以写个小脚本自动生成对应的RBS代码，避免手动重复劳动。

方案二：仅使用YARD @!method + @return标签 #

如果你的团队主要依赖YARD做文档和代码补全，对独立的类型签名需求不强，这个方案足够简洁：
YARD的标签已经能被RubyMine识别提供补全，也能生成标准的HTML文档，完全覆盖动态方法的文档需求，不需要额外维护RBS文件。示例和方案一里的YARD代码一致。

注意事项 #

• 动态生成的方法名、参数列表必须和YARD/RBS里的声明完全匹配，否则工具无法识别。
• 如果使用RBS，要确保RubyMine开启了RBS支持（在设置里搜索RBS即可配置），同时项目里安装了rbs gem。

内容的提问来源于stack exchange，提问作者Mailo Světel