Yard文档:第一行描述

时间:2015-07-03 12:11:28

标签: ruby-on-rails ruby documentation yard

我的院子有问题,我的所有文字都是:

# General description.
#
# @param [] param ...
# @return [] description of the return

但第一行有时被返回的描述所取代。 我试过没有空白:#General ..

1 个答案:

答案 0 :(得分:0)

我通过反转该行的顺序解决了这个问题:

# @param [] param ...
# @return [] description of the return
# General description.

但我不认为这是更好的方式......