나는이 반환하는 함수가있는 경우 :이처럼 문서화하고 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 th
야드로 문서를 생성하고 있지만 레일즈 프로젝트에서 루비에 대한 예제 문서를 찾을 수 없습니다. 나는 단지 getting started tutorial이라는 짧은 글과 rubydoc.info의 일부 github 프로젝트를 발견했지만, 그들은 전혀 문서화되지 않았다. class ArticlesController < ApplicationController
내가 루비 파일의 방법과 의견을 추출하고 나는이 조각으로 분사하는 관리이 전에 참고 자료로 DB에 을 저장할 필요가 어디 작업을 확인에서 방법과 의견을 받기 코드가 같은 module Describe
def describe(method_name,description)
@@method_descriptions ||= []
@@metho
내 RSpec spec_helper.rb에 pry을 요구하고 내 사양을 실행하면 많은 경고가 발생합니다. 어떻게 제거합니까? /Library/Ruby/Gems/2.0.0/gems/pry-0.10.0/lib/pry/commands/bang.rb:3: warning: ambiguous first argument; put parentheses or even sp
YARDoc을 사용하여 다음과 같은 방법으로 문서화하고 있습니다. dangerous 굵게입니다 # Here is my method
# @arg woop [Woop] *dangerous* this parameter is output to the screen
def shoop(woop)
puts woop
end
이것은 HTML을 생성합니다.
내 코드를 문서화하는 데 관심이 있습니다. 대다수는 내가 이 아닌 새 클래스를 만드는 스크립트입니다. YARD 문서를 읽고 YARD 설명서를 실제로 구현하려고하면 정의 된 클래스 내에서 YARD 태그를 선언 한 것으로 보입니다. 아래 예제 코드에서와 같이 클래스를 만들거나 클래스에 새 메서드를 추가 할 때 YARD를 성공적으로 사용했으며 @author 및
일부 Ruby 클래스에 대한 설명서를 생성하는 데 yard을 사용하고 있습니다. # @raise [ArgumentError] Cause 1
# @raise [ArgumentError] Cause 2
# @raise [ArgumentError] Cause 3
# @raise [ArgumentError] ...
# @raise [ArgumentError
RDOC 섹션과 동일합니다 (YARD 포함)? 내가 분류 된 API를 구축하고자 http://www.ruby-doc.org/stdlib-1.9.3/libdoc/rdoc/rdoc/RDoc/Context/Section.html를 참조하고, 절을 할 수있는 좋은 방법이 될 수 있습니다.
마당 보석은 루비 코드의 문서를 생성하는 도구입니다. 명령 줄을 통해 완료되며 문서가 생성됩니다. 그러나 IRB를 통해 구문 분석 된 코드 및 통계와 상호 작용할 수 있는지 궁금합니다. 당신은 IRB에 가서 같이 야드를 호출 할 수 있습니다 : 나는 코드와 상호 작용하거나 얻을 통계를 분석 할 수없는 것 그러나 require 'yard'
YARD
.