[心得] 用Yard来写文件似乎不错

楼主: dragonyy (dragon)   2013-01-22 17:12:23
主要是在“型态”的标示上。
以前用RDoc的方式来写,我可以知道某个方法有什么参数(名称),却
不见得可以望文生义(有的名字取得好的话是可以“猜”出来的),多
少要再去查范例才知道怎么用。
现在用Yard来写,基本上RDoc的用法都可以沿用(没试过,文件上说的)
最主要我喜欢的地方在于
# @param [String] name 这是一个名字
# @return [MyModule::MyClass] 传回一个这个类别
def my_method(name)
...
end
产生文件后,可以清楚地知道这个方法收一个字串,传回一个类别变量。
甚至还有包括传进去一个Hash的话里面该有哪些键,代表什么意义,是什
么型别(类别),以及其他的种种好用的用法。
如果对产生文件有兴趣的朋友,可以试试。
http://yardoc.org/guides/index.html

Links booklink

Contact Us: admin [ a t ] ucptt.com