yard

    1熱度

    2回答

    即時搜索支持以下功能的文檔框架: 從代碼生成的註釋 檢索 造型定製 NTH:鏈接引用(如果我引用類的某處類名稱應鏈接到類文檔) 我想要使用它記錄的問題的REST API我正在 我知道YARDoc,但會很高興地收集一些替代

    2熱度

    1回答

    YARD約定是否有約定,以表明YARD樣式文件中的參數僅用於其「感實性」的地位,這是你只是想知道,如果它是false或nil或者是truthy? 什麼是典型的代替Truthy在以下? # @param [String] name # @param [Truthy] admin_status def create_user(name, admin_status) # code goes

    0熱度

    2回答

    爲了本地化我的黃瓜腳本,我在每個.feature文件的頂部添加了#language:ru評論,並開始使用本地化名稱來執行步驟和場景。 但是,在使用yard-cucumber插件記錄我的腳本後,此註釋在生成的html文檔中不顯示(並且在功能名稱下可見)。它還在每個Background/Scenario塊之後添加諸如features/category_info.feature:3之類的行。它是一些調試

    0熱度

    1回答

    我想生成一些公開可用的文檔,因此我希望刪除默認情況下Yard生成的輸出的某些方面。我已經設法刪除源代碼及其鏈接,但我也想刪除: 類名。 繼承信息。 「在...中定義」信息。 如果可能的話,「Class List」| 「方法列表」| 「文件列表」菜單。 我通過添加除去源: def init super sections.first.delete(:source) end 到

    8熱度

    2回答

    如何創建鏈接到紅寶石類方法與YARD?這裏是關於鏈接的yard documentation。 鏈接到同一個命名空間內的實例方法: {#my_instance_method} 工作正常。然而,在與一個類方法不編譯同樣的方法,並修改它: {#self.my_class_method} 產生以下的純文本(不是鏈接): ObjectName#self#self.my_class_method

    4熱度

    1回答

    我正在寫我的第一個gem,我正在用YARD進行記錄。我已經讓我的一個類有一個構造函數,它需要一個不帶參數的塊。 YARD提供@yield [params] description標記來描述一個方法將傳遞給它的參數的塊參數,但如果params列表爲空,它將無法正確格式化。我應該如何記錄一個沒有參數的塊? :從技術上說,我甚至沒有yield ing塊;我有一些代碼,看起來像這樣: def initia

    0熱度

    1回答

    我正在使用RVM,Ruby v1.9.3-p125和Ruby on Rails v3.2.2。在我的Ubuntu的服務器我試圖安裝remotipart v1.0.2寶石,但我得到了以下錯誤: $ gem install remotipart -v 1.0.2 Successfully installed remotipart-1.0.2 1 gem installed Installing

    1熱度

    1回答

    作爲git commit工作流程的一部分自動生成ruby文檔的最佳做法是什麼?我們希望在提交合併到主機時自動生成新的文檔。

    0熱度

    1回答

    這個問題我已經寫YARD插件以下DSL: class MyClass my_dsl :do_it, :do_other def do_it # do it end def do_other # do other end def do_unrelated # do unrelated end end

    4熱度

    1回答

    我下載了ruby Twitter gem源代碼,並試圖使用代碼生成文檔,我通過gem install yard安裝。在Rake文件,我發現下面的,我以爲是用來產生Twitter的寶石文檔: require 'yard' YARD::Rake::YardocTask.new 我試圖require yard在IRB然後運行YARD::Rake::YardocTask.new但什麼都沒有發生。 你