文件名称：yard-contracts:来自合同的自动参数文档的 YARD 插件
文件大小：15KB
文件格式：ZIP
更新时间：2024-07-04 15:29:13
Ruby
堆场合同 yard-contracts 是一个 YARD 插件，可与出色的 gem 配合使用，自动记录方法签名中的参数类型和描述，节省时间，使代码简洁并保持文档一致。 您是否厌倦了编码验证、编写错误消息然后记录这些事情？ 所有这些重复和样板代码一直困扰着我。 Contracts 已经解决了验证和错误消息部分，将多行重复代码变成了 1 行简洁易读的代码。 此扩展现在解决了文档部分，使文档自动与您的验证相同。 从 Contract 中收集的类型并自动与方法签名链接，然后添加到参数文档中。 to_s 在类型和它有用的地方被调用，作为描述添加到 param 文档中。 如果已经手动记录了任何参数，则合同中的额外信息将被合并而不是覆盖或复制； 允许充分的灵活性。 我已经在现有项目中使用了这个插件 gem 并记录了 69 种方法； 它似乎工作得很好！ 注意我没有用过 YARD 的所有角落，所
【文件预览】：
yard-contracts-master
----.gitignore(122B)
----.rspec(31B)
----bin()
--------setup(115B)
--------console(339B)
----.travis.yml(99B)
----CODE_OF_CONDUCT.md(1KB)
----LICENSE.txt(1KB)
----spec()
--------nokogiri_wrapper.rb(580B)
--------spec_helper.rb(84B)
--------yard-contracts()
--------yard-test()
----README.md(7KB)
----lib()
--------yard-contracts()
--------yard-contracts.rb(113B)
----yard-contracts.gemspec(1KB)
----Gemfile(99B)
----Rakefile(29B)