Yuidoc-стиль комментариев в Ruby?

Question

Как я могу использовать комментарии YUIDoc в Ruby? Лучшее, что я могу придумать это:

##* 
    # Get Query history 
    # @type {Array} Past search query objects 
    # @param {int} limit The number of objects to return. Defaults to 10. (Max 100). 
    # @param {boolean} only_visible limit the search to visible items. Defaults to true. 
    # 

И это:

#/** 
    # * Get Query history 
    # * @type {Array} Past search query objects 
    # * @param {int} limit The number of objects to return. Defaults to 10. (Max 100). 
    # * @param {boolean} only_visible limit the search to visible items. Defaults to true. 
    # */ 

Answer 1

Вы должны вставлять комментарии YUIDoc внутри многострочного комментария Руби, как это:

=begin 
/** 
* Get Query history 
* @type {Array} Past search query objects 
* @param {int} limit The number of objects to return. Defaults to 10. (Max 100). 
* @param {boolean} only_visible limit the search to visible items. Defaults to true. 
*/ 
=end 

= знак до begin и endдолжен быть на первом столбце линии.