Что @param и @return означают в Ruby?

Question

Я только начинаю задавать вопрос о 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}

Answer 1

С https://yardoc.org/:

YARD - это инструмент создания документации для языка программирования Ruby.Он позволяет пользователю создавать непротиворечивую, пригодную для использования документацию, которую можно очень легко экспортировать в несколько форматов, а также поддерживает расширение для пользовательских конструкций Ruby, таких как пользовательские определения уровня класса.

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

isярд документация метода add_two_numbers.Это означает, что метод принимает два параметра (l1 и l2, оба являются ListNode экземплярами) и возвращает новый ListNode экземпляр.