yard

0熱度

1回答

我正在使用yard爲某些Ruby類生成文檔。我們可以記錄一些錯誤，可以通過一種方法這樣的方式籌集： # @raise [ArgumentError] Cause 1 # @raise [ArgumentError] Cause 2 # @raise [ArgumentError] Cause 3 # @raise [ArgumentError] ... # @raise [Argumen

30熱度

1回答

如何使用YARD記錄Rake任務？

我想在我們的Rails應用程序中包含有關Rake任務的信息。我們使用YARD作爲文檔，目前像lib/tasks/development.rake這樣的頁面默認顯示爲未格式化的文本。我可以使用# @markup rubyfrom the YARD documentation將它們渲染爲Ruby源代碼。但是，這只是呈現任何評論內聯，即使他們包括YARD指令，如# @!method foo。這意味着

0熱度

1回答

YARD - 資源處理程序 - 記錄在每個塊中聲明的defs

如何編寫在.each塊中收集的定義的文檔？我的特例是Middleman，但我認爲這個問題更加普遍，而Google今天的表現令人失望。例如： def manipulate_resource_list(resources) resources.each do |resource| # Provides a greeting # @return [string] Re

0熱度

1回答

如何使用TomDoc語法在YARD中記錄config_accessor方法？

我正在處理包含ActiveSupport的可配置模塊的代碼，並試圖記錄配置訪問器。任何人都知道如何在YARD Tomdoc中這麼做？我試過以下，但它似乎沒有呈現文檔中的任何東西。 class MyConf include ActiveSupport::Configurable # Is this configuration awesome? (defaults: tru

2熱度

1回答

堆場和C擴展

我有一個C紅寶石擴展，我用rdoc文檔。有rdoc解析的C文件和ruby文件。院子裏能做同樣的事情嗎？有沒有一種「簡單的方法」，（我的意思是一種常用的方式）從rdoc遷移到院子裏？

1熱度

1回答

如何從代碼文檔中隱藏查看源代碼？

Iam使用院子裏的文件在我的項目中，但我不想向用戶顯示我的源代碼。有沒有辦法在院子裏隱藏源代碼。

1熱度

1回答

堆場文檔：描述

我有院子問題的第一線，我所有的文字是這樣的： # General description. # # @param [] param ... # @return [] description of the return 但第一行是有時通過返回的描述替代。我嘗試沒有blankspace：#General ..

5熱度

1回答

記錄一個呈現Jard和Yard的函數？

如果我有一個返回值這個函數： render :json => @orders.as_json(include: [{:user => {only: :id}}], :only => [:id, :status_id]) 我記錄這樣的： # @return [JSON] includes the id, the order status id and the id of the associat

2熱度

1回答

作爲Ruby測試的文檔？

有一個偉大的工具rustdoc（cargo目前使用）到test examples of documentation comments in Rust。在Ruby中，rdoc或者yard是否給了我們類似的東西？

1熱度

1回答

用Rails 4.2中的YARD替換RDoc

Rails 4.2中可以用YARD替換RDoc嗎？我希望rake doc:app可以調用YARD而不是RDoc。在我的Gemfile中，我用YARD（gem 'yard', '~> 0.8.0', group: :doc）替換了sdoc，沒有運氣。