gpt4 book ai didi

ruby - 有什么标准方法可以定义对象使用库所需的方法吗? (很像一个界面)

转载 作者:太空宇宙 更新时间:2023-11-03 18:18:55 26 4
gpt4 key购买 nike

<分区>

考虑到我全职使用 Ruby(最后是 Rails),所以我绝对了解这门语言

最近我正在开发一个 gem,它需要与程序员发送的一些对象进行交互,并且这些对象需要以某种方式表现。

考虑到我喜欢的 duck-typing 代码风格,我必须承认在这种情况下接口(interface)(如 Java/C# 等)很有用,不是为了实现而是为了文档目的.

我通常会写一个自述文件,然后放在那里:该方法接受一个对象,该对象应该响应这个那个等等等等等等
这种方法的主要问题是我忘记在发生变化时更新自述文件,而且我没有找到解决方案。

是否有任何库或类似的东西可以帮助我通过查看代码或代码文档来生成这样的自述文件?在类的顶部作为文档输入类似的内容(请注意,这是一种即时发明的语法,其中包含一些 YAML):

# @Interface
# method_name:
# param1_name:
# type: String
# param2_name:
# type: Object
# respond_to:
# - method_1:
# param1_name:
# type: String
# returns:
# type: Object
# respond_to:

...类似这样的事情(这只是一个想法)。如果有某种东西可以以某种方式解析代码,那就更好了,但我知道 Ruby 或多或少无法解析,因为它是动态

关于如何执行此操作的任何建议、最佳实践 或标准方法?我希望程序员在编写必须与我编写的 gem 交互的代码时感到舒服。

26 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com