YARD 如何記錄數組的@param <array<string> > </array<string>
[英]YARD how to document a @param of Array<Array<String>>
假設我有以下 function：@param foo [Array<String>] def recursive_split(foo) bar = [] foo.each do |elem| bar.append(elem.split('')) end bar ...
堅持使用 rdoc：有什么方法可以為 call-seq 添加縮進？
[英]Stuck with rdoc: Any way to add indentation to call-seq?
我知道我應該使用 YARD。 在這種環境中不是一個選項。 所以我使用 rdoc 並且 call-seq 通常很棒，但是我想為始終以塊/yield 樣式使用的 call-seq 添加縮進，例如： 但是 call-seq: 刪除任何縮進，它變成： 這是可悲的。 我知道我可以使用單獨的代碼塊作為 ...
YARD 如何記錄數組的@param<string> 類型也可以是空白數組？</string>
[英]YARD how to document a @param of Array<String> type which could also be a blank array?
以下是接受字符串數組或空白數組 ( [] ) 的方法片段：# @param [Array<String>] bar def foo(bar) if bar.empty? # Do this else # Do that end end 我覺得這種@para ...
Rdoc：如何記錄委托？
[英]Rdoc: How to document delegation?
我的 class 將一個方法委托給另一個 object（我將其稱為輔助對象）。 我想在委托 class 中包含該方法的文檔，而不僅僅是委托 class。 程序員不應使用幫助程序 object，而應僅使用主 object，因此在幫助程序 object 中記錄不是很有用。 考慮這個例子。 Rdoc ...
如何在 JRuby 中安裝 ri 文檔？
[英]How do I install ri documentation in JRuby?
我在 Windows 系統上安裝了 JRuby 9.2.11.1。 安裝成功完成后，不存在 core/stdlib 的 ri 文檔。 例如： 我試過這個解決方案如何安裝 Ruby ri 文檔？ （誠然，對於 Ruby 安裝程序，而不是 JRuby）無濟於事。 嘗試運行rdoc --all --r ...
有沒有辦法強制 RDoc 不設置與類或模塊相對應的單詞樣式？
[英]Is there a way to force RDoc to not style words, which correspond to classes or modules?
我正在嘗試使用 RDoc 將文檔寫入我的一個類，但我遇到了以下問題： 這是我的來源：module Native module Facebook # Service, which starts(schedules) Native Facebook Fetching Jobs for us ...
如何在ruby documentor中聲明特定類型的數組？
[英]How to declare array of a particular type in ruby documentor?
我想在rubydoc中為參數或變量或@return聲明具有確切對象類的對象數組。 （必須是RDoc ？。） 使RubyMine（或其他IDE）以正確的方式工作於自動完成功能，可點擊方法，重構等的主要原因是。 在PHP中將如下所示： 我只是不確定它是否可以在RubyMine中 ...
內聯RubyDocumentor行像在PHP中一樣？
[英]Inline RubyDocumentor line like in PHP?
在PHP中，我們可以描述任何變量，並在類似PHPStorm的IDE中獲得正確的自動完成功能。 有什么方法可以使用RDoc在RubyMine中實現？ ...
Ruby Yard 文檔：如何添加“逐字”（生成類似<pre>標簽）
[英]Ruby Yard documentation: how to add a “verbatim” (to generate something like a <pre> tag)
我想要一段代碼，如哈希，在生成的 html 上以固定字體顯示。 假設這是我的文件的內容： 如何指示 yard（使用版本0.9.15的默認值）以便yard doc file.rb將生成，對於哈希示例，相當於在 markdown 格式中添加 4 個反斜杠，或 4 個起始空格到 stackoverfl ...
如何在單個文件上運行rdoc而不覆蓋所有其他文件？
[英]How do you run rdoc on single files without overwriting all other files?
我正在做一個非常大的Rails項目，我想在代碼庫中標准化rdoc的用法。 我認為我可以在整個項目中運行一次（至少為類和方法本身生成文檔），然后開發人員可以在添加文檔時添加單個文件。 問題是，如果我運行rdoc /path/to/some_file.rb ，它將從生成的index.html ...
如何使用RDoc記錄文件
[英]How to document a file with RDoc
搜索RDoc文檔后，我找不到如何在RDoc中記錄文件/頂級方法... 假設我有以下代碼： 使用此代碼運行RDoc只會生成Foo類的文檔，在這里我想擁有foo.rb文件和頂級方法foo_method（）的文檔。 所以我的問題是： 如何使RDoc文檔文件和頂級方法？ ...
rdoc中的行繼續
[英]Line continuation in rdoc
我繼承了帶有rdoc注釋的一堆Ruby代碼，但是許多選項和屬性都是多行的，例如： 使用rdoc，sdoc或yard很難閱讀最終文檔。 每個顯示第二行的方式都不同。 我想念什么嗎？ 有什么方法可以保留換行符，但可以使生成的文檔正確嗎？ ...
發生名稱沖突時，如何告訴RubyMine我正在使用哪個類？
[英]How to tell RubyMine what class I'm using when there are name conflicts?
在Padrino項目中，Ruby本身很聰明，知道我要引用我的Page模型而不是分頁器的Page類。 但是RubyMine迷路了，認為我正在處理分頁並堅持標記一些錯誤（隨着new論點的變化）。 在這些情況下我該怎么辦？ 在PHPStorm上，我習慣在變量上方添加一個PHPDoc來告訴 ...
Rails何時生成readme.md（而不是readme.rdoc）？
[英]When does Rails generate a readme.md (as opposed to a readme.rdoc)?
我注意到，當我生成一個新的Rails應用程序時，有時我會遇到一個readme.md，有時甚至是一個readme.rdoc（Bitbucket顯然不會自動呈現）。 如果您對此有任何想法，請告訴我。 ...
`require'：無法加載這樣的文件 - rdoc / usage（LoadError）
[英]`require': cannot load such file — rdoc/usage (LoadError)
運行我的腳本時出現此錯誤： 從 我在我的Gemfile中有rdoc 我也試過沒有指定版本。 在我的腳本中，我需要寶石和rdoc /用法： 我已經運行了gem install rdoc 因為我正在運行ruby 2.2.2應該不需要安裝ruby roc / ...
RDoc :: TopLevel的未定義方法`reset'：安裝新的Ruby gem時的類
[英]undefined method `reset' for RDoc::TopLevel:Class when installing a new Ruby gem
例如， 安裝任何新gem時，會引發NoMethodError異常。 我搜索了它並搜索了RDoc和RubyGems GitHub存儲庫中的問題，但沒有運氣。 我的Ruby版本是 RubyGems版本是 安裝的RDoc版本是 我在Mac OS X El Cap ...
Rdoc，YARD和irb，在數組上使用內部方法？
[英]Rdoc, YARD and irb, using intern method on an array?
我只是想為我的gem生成文檔，並且在運行rdoc或yard時出現錯誤 到底是怎么回事？ 我正在嘗試重新安裝所有內容，並且使用的是ruby 2.3.1。 另外，據我了解，您不能在數組上使用intern，那么為什么rdoc和yard會嘗試這樣做？ 編輯 我現在已經進行了進一步 ...
使用 yard 的 Rails 控制器文檔
[英]Documentation of Rails controllers using yard
在嘗試創建我的 rails 控制器和使用的參數的文檔時，我被卡住了，因為 yard 似乎期望參數作為方法參數存在。 所以對於這個文檔 yard 會發出警告並且不會創建文檔： 有沒有辦法使用 yard 來記錄這些類型的物品，還是我需要手動完成？ ...
耙子流產！不知道如何構建任務'doc：app'
[英]Rake aborted! Don't know how to build task 'doc:app'
官方文檔表明我應該能夠使用rake doc:app為我的應用程序構建文檔，但是當我在Rails 5中運行命令時，我得到以下輸出： ...
如何使用在http://www.rubydoc.info/網站中定義的方法
[英]How to use methods define in http://www.rubydoc.info/ site
我有開放式的Rails控制台，想使用復數方式，但是我收到錯誤，因為NoMethodError: undefined method main：Object`的NoMethodError: undefined method 復數（1，'人'） 我可以在這里http://www.rubyd ...