yard

    1熱度

    2回答

    我記錄了一些使用YARD的Ruby代碼,並且我無法獲得我爲頂級命名空間中的某些方法創建的YARD 文檔,該文檔顯示在yardoc的HTML輸出中。 我的文檔看起來基本上與YARD寶石自己的 lib/yard/globals.rb相同,但增加了@api標記。我嘗試刪除它, 並運行yardoc沒有--api參數,但這並沒有什麼幫助。 這是一個例子: #!/usr/bin/ruby # @group

    4熱度

    2回答

    我正在生成與Yard的文檔,但我找不到任何ruby rails項目的文檔。我發現只有短的getting started tutorial和一些github項目rubydoc.info,但它們根本沒有記錄。請能有人告訴我如何正確記錄控制器(用行動),型號,鋼軌線路項目 比如我有這樣的控制器: class ArticlesController < ApplicationController

    1熱度

    1回答

    我正在使用Yard生成文檔,但即使運行了yardoc --private,它也不會在源代碼中顯示私有方法的文檔。 有什麼不對?

    3熱度

    1回答

    好吧,我有任務在那裏我必須提取ruby文件的方法和意見,這一點,我管理着這片分拆之前在DB將它們存儲爲參考 方法和意見代碼來達到同樣的 module Describe def describe(method_name,description) @@method_descriptions ||= [] @@method_descriptions << [method_n

    4熱度

    1回答

    我有以下方法,我想使用YARDoc文檔。 # Here is my method # @arg woop [Woop] *dangerous* this parameter is output to the screen def shoop(woop) puts woop end 這會生成HTML,其中dangerous以粗體顯示。因爲我必須解析這個輸出,所以我想要有一個自定義

    0熱度

    1回答

    運行堆場時,然後單擊文件鏈接,我得到這個: 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

    2熱度

    1回答

    我查找了帶有gem的模板(我只能找到默認的HTML輸出器),我搜索了一個將重定向到STDOUT的開關的幫助和在線文檔。我無法找到任何有關如何處理此問題的信息。 有沒有一種簡單的方法來做到這一點(也許是一個shell命令?)還是我有通過源代碼?

    2熱度

    1回答

    我有興趣記錄我的代碼,其中大部分是腳本,我不會創建新類。 從閱讀YARD文檔,並試圖實際實現一些YARD文檔,似乎你聲明你的YARD標籤在一個定義的類。我在創建類或向類中添加新方法時成功使用了YARD,如下面的示例代碼所示,並且我還能夠使用YARD標記(如@author和@example)記錄簡單的事情。 #!/usr/bin/env ruby -wKU ## a YARD test cl

    2熱度

    1回答

    RDoc部分有相當於YARD? 見http://www.ruby-doc.org/stdlib-1.9.3/libdoc/rdoc/rdoc/RDoc/Context/Section.html 我要建立分級式API,以及部分可能是做的很好的方式。

    0熱度

    1回答

    Yard有一個標籤@!method來描述動態創建的實例方法的文檔。類方法是否有類似的標籤?