@param和@return在Ruby中是什么意思?

时间:2019-04-29 00:04:11

标签: ruby parameters

我只是对leetcode提出一个问题,我只是想知道一点代码的语法是什么意思。

# Definition for singly-linked list.
# class ListNode
#     attr_accessor :val, :next
#     def initialize(val)
#         @val = val
#         @next = nil
#     end
# end

# @param {ListNode} l1
# @param {ListNode} l2
# @return {ListNode}

def add_two_numbers(l1, l2)

end

我很难理解这个特定部分的含义。

# @param {ListNode} l1
# @param {ListNode} l2
# @return {ListNode}

1 个答案:

答案 0 :(得分:5)

来自https://yardoc.org/

  

YARD是用于Ruby编程的文档生成工具   语言。它使用户能够生成一致,可用的   可以很容易地导出为多种格式的文档,   并且还支持扩展自定义Ruby结构,例如custom   类级别的定义。

# @param {ListNode} l1
# @param {ListNode} l2
# @return {ListNode}

add_two_numbers方法的YARD文档。这意味着该方法采用两个参数(l1l2,它们都是ListNode实例)并返回一个新的ListNode实例。