이번에는 변경자 중에 아래와 같은 것들을 사용해 보고자 한다.
:call-seq: lines...
:include: filename
:title: text
:main: name
:stopdoc: / :startdoc:
:enddoc:
# :title: Modified Title
# \:title: Modified Title -> Set Page title to 'Modified Title'
#
# :main: lib/test_rdoc_3.rb
# \:main: lib/test_rdoc_3.rb -> Set start page to 'lib/test_rdoc_3.rb' 's RDoc document page
#
# \:include: README -> Include 'README' 's content to Comment
#
# :include: README
class TestRDoc3
# :call-seq:
# test_rdoc_3.test(val) -> val
# test_rdoc_3.test(val) {|val| ... } -> val
#
# test appears RDoc
def test(val, &block)
return yield val if block_given?
return val
end
#:stopdoc:
# method_1 doesn't appear RDoc
def method_1
end
#:startdoc:
# class_method_1 appears RDoc
def TestRDoc3.class_method_1
end
#:enddoc:
def method_2
end
def method_3
end
end
|
소스 창을 띄워놓고 보기 : http://codepad.org/VWs0POzl
결과는 아래와 같다
참고로, ‘RDocTestProject … ‘ 부분이 README 의 내용이다
보이지 않는 부분(:title: / :main:) 의 적용된 모습에 대해 설명하자면…
주석의 설명대로, 브라우저의 타이틀은 ‘Modified Title’ 로 변경된다
(명령행 인자 중 --title 과 동일한데, 명령행 인자가 우선한다)
그리고 index.html 을 열었을 때 test_rdoc_3.rb 의 RDoc 페이지가 맨 처음 뜬다.
(이것도 명령행 인자 중 –-main 과 동일하다)
'Dev.Programming > Lang.Ruby' 카테고리의 다른 글
| CruiseControl.rb(1.3.0) 를 윈도우에서 사용할 경우 (0) | 2009/04/25 |
|---|---|
| RDoc vol.4 from 곡괭이 (RDoc::usage) (4) | 2009/04/23 |
| RDoc vol.3 from 곡괭이 (0) | 2009/04/23 |
| RDoc vol.2 from 곡괭이 (0) | 2009/04/23 |
| RDoc vol.1 from 곡괭이 (0) | 2009/04/23 |
| Hpricot 으로 XML 을 파싱하면... (0) | 2009/04/23 |
