我正在生成與Yard的文檔,但我找不到任何ruby rails項目的文檔。我發現只有短的getting started tutorial和一些github項目rubydoc.info,但它們根本沒有記錄。請能有人告訴我如何正確記錄控制器(用行動),型號,鋼軌線路項目 比如我有這樣的控制器: class ArticlesController < ApplicationController
我有以下方法,我想使用YARDoc文檔。 # Here is my method
# @arg woop [Woop] *dangerous* this parameter is output to the screen
def shoop(woop)
puts woop
end
這會生成HTML,其中dangerous以粗體顯示。因爲我必須解析這個輸出,所以我想要有一個自定義
運行堆場時,然後單擊文件鏈接,我得到這個: incompatible marshal file format (can't be read)
format version 4.8 required; 114.101 given
/Users/snowcrash/.rvm/gems/ruby-2.0.0-p195/gems/yard-0.8.6.2/lib/yard/registry_s
我有興趣記錄我的代碼,其中大部分是腳本,我不會創建新類。 從閱讀YARD文檔,並試圖實際實現一些YARD文檔,似乎你聲明你的YARD標籤在一個定義的類。我在創建類或向類中添加新方法時成功使用了YARD,如下面的示例代碼所示,並且我還能夠使用YARD標記(如@author和@example)記錄簡單的事情。 #!/usr/bin/env ruby -wKU
## a YARD test
cl