Ruby中的Yuidoc風格評論？

Question

如何在Ruby中使用YUIDoc評論？我能想出的最好的是這樣的：

##* 
    # 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評論Ruby的多行註釋裏面，像這樣：

=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之前的字符必須是該行第一列的。