Ruby Documentation System (RDoc) �Ȥ�, Ruby �ǽ줿�����������ɤ��� �ɥ�����Ȥ�ư��������, Ruby ���Τ���°����ɸ��饤�֥���1�ĤǤ�.
RDoc �� Ruby �����������ɤ���Ϥ�, ���饹, �⥸�塼��, ��åɤ���� ��ȴ���Ф�, include �� require �˴ؤ��Ʋ�ᤷ�ޤ�. �����Ƥ��������� �Ȥ���ľ���˽줿�����Ȥ�ʻ�礷, HTML �ɥ�����Ȥ���Ϥ��� ��. �ܤ��������ͻ��� 1,2 �Ȥ�������.
�ʲ��Ǥ�, �ޤ� RDoc �Υ��ȡ����Ԥ��ޤ�. ������ Ruby �Ǵ�ñ�ʥ��� ���饤�֥��������, RDoc ���Ѥ��Ƥ��Υץ�����फ��ɥ�����Ȥ��� �����Ƥߤޤ�.
����Ȥ���, Ruby ���ΤΥ��ȡ���ϹԤäƤ����Ƥ�������.
Fedora Core ��
# yum install rdoc
Vine, Debian ��
# apt-get install rdoc
���Υǥ��쥯�ȥ�������, ���Υǥ��쥯�ȥ���˰�ư���Ƥ�������. ���� �ǥ��쥯�ȥ����, rdoc �Ȥ������ޥ�ɤ��¹ԤǤ��뤳�Ȥ��ǧ���� ��������.
$ mkdir rdoc_test $ cd rdoc_test $ rdoc
�ʲ��Τ褦�ʥ�å�������ɽ������, doc �Ȥ����ǥ��쥯�ȥ꤬���� ����Ƥ���� OK �Ǥ�.
Generating HTML... Files: 0 Classes: 0 Modules: 0 Methods: 0 Elapsed: 0.262s
�ޤ�, GPhys ���Ѥ��ƴ�ñ�ʥ��饹�饤�֥���������ޤ��礦. (������ �����Υ��塼�ȥꥢ��Ǵ��� GPhys �����Ѳ�ǽ�ʾ��֤��Ȳ��ꤷ�Ƥ��ޤ�). �ʲ��Υץ�������������Ƥ�������. <URL:sample/gphys_cont1.rb>
class GPhys_cont require "numru/ggraph" ; include NumRu FILENAME = 'T.jan.nc' attr_reader :var def initialize(var='T') @var = var end def cont gphys = GPhys::IO.open(FILENAME, @var) DCL.gropn(1) ; DCL.sgpset('lcntl', false) ; DCL.uzfact(0.7) GGraph.contour( gphys) DCL.grcls end end if __FILE__ == $0 gphys = GPhys_cont.new gphys.cont end
if __FILE__ == $0
�ʹߤ���ʬ��, ���Υץ�������¹Ԥ����ݤ�
�ᥤ��ʸ��������ޤ�. ���Υץ������ϼºݤˤ�
GPhys ���塼�ȥꥢ�� -- 6. �Ȥꤢ�����Ļ벽
�Τ褦��ư��ޤ�. �ʲ��Υǡ����ե���������������ɤ�����, �嵭��
Ruby ������ץȤ� ruby �Ǽ¹Ԥ��ƤߤƤ�������.
�����������: NetCDF�ե����� T.jan.nc
$ ruby gphys_cont1.rb
�⤦1��, ���Υ��饹��Ѿ��������饹�饤�֥���������Ƥߤޤ��礦. �ʲ��Υץ�������������Ƥ�������. <URL:sample/gphys_tone1.rb>
require "gphys_cont1" class GPhys_tone < GPhys_cont attr_accessor :draw_tone def initialize super @draw_tone = true end def tone(itr=1) gphys = GPhys::IO.open(FILENAME, @var) DCL.gropn(1) ; DCL.sgpset('lcntl', false) ; DCL.uzfact(0.7) GGraph.set_fig( 'itr'=>(itr == nil) ? 1 : itr.to_i) GGraph.tone( gphys ) if @draw_tone GGraph.contour( gphys, !@draw_tone ) DCL.grcls return true end end if __FILE__ == $0 gphys = GPhys_tone.new gphys.tone end
���Υץ�������, gphys_cont1.rb �ο��ɤ��ǤǤ�.
$ ruby gphys_tone1.rb
�Ǥϼ���, RDoc ���Ѥ��Ƥ��Υ��饹�饤�֥��Υ�ե���ޥ˥奢��� ��ư�������Ƥߤޤ��礦. gphys_cont1.rb, gphys_tone1.rb ���֤��Ƥ���ǥ� �쥯�ȥ�ǰʲ��Υ��ޥ�ɤ�¹Ԥ��Ƥ�������.
$ rdoc gphys_cont1.rb gphys_tone1.rb --main GPhys_cont
���Υ��ޥ�ɤˤ��, doc �Ȥ����ǥ��쥯�ȥ꤬��������, ������� RDoc �� ��äƺ������줿�ɥ�����Ȥ����Ϥ��줿�Ϥ��Ǥ�. �֥饦���� doc/index.html �Ƥߤޤ��礦. �ʲ��Τ褦�ʥڡ�����ɽ�������Ϥ��Ǥ�.
���ʤ� 3 ʬ�䤵�줿�ե졼��˥ե�����, ���饹����ӥ⥸�塼��, ��� �ɤΥꥹ�Ȥ�ɽ������Ƥ��ޤ�. ������ʬ�ˤ� GPhys_cont ���饹�����Ƥ� ɽ������Ƥ��ޤ�. ���Υե졼��Υ�å�̾����ʬ��å������, ���� �������ɤ�ɽ������ޤ�.
�����������ɤ˥����Ȥ������ळ�Ȥ�, �ɥ�����Ȥˤ��¿���� ������ղä��Ƥߤޤ��礦. gphys_cont1.rb �˥����Ȥ��ɲä��� �ʲ��Υե������������ޤ��礦.
# # GPhys �����Ѥ����������ޤ����褹�륯�饹�饤�֥�� # class GPhys_cont require "numru/ggraph" ; include NumRu # �ե�����̾ (����) FILENAME = 'T.jan.nc' # ���褹���ѿ� attr_reader :var # # ����������ѤΥ�å�. ���� _var_ �ˤ����褹���ѿ��� # Ϳ���ޤ�. # def initialize(var='T') @var = var end # # �� ���Ԥ�������, ����������ʬ��̵�뤵��ޤ�. # # # �������ޤ������¹Ԥ��ޤ�. # def cont gphys = GPhys::IO.open(FILENAME, @var) DCL.gropn(1) ; DCL.sgpset('lcntl', false) ; DCL.uzfact(0.7) GGraph.contour( gphys) DCL.grcls end end if __FILE__ == $0 gphys = GPhys_cont.new gphys.cont end
���饹���å������ľ���˽�Ƥ��륳���Ȥ��ơ��Υɥ�����Ȥ� ���Ʋ�ᤵ��ޤ�. �ʤ�, ���Ԥ줿�ʳ��Ǥ�������������ʬ (��Υ��� �������ɤǸ����ȡ֢� ���Ԥ�������...�פ���ʬ) �ϥɥ�����ȤȤ��Ʋ�� ����ޤ���.
�Ǥ�, ���� rdoc ���ޥ�ɤ�¹Ԥ��Ƥߤޤ��礦.
$ rdoc gphys_cont2.rb gphys_tone1.rb --main GPhys_cont --charset euc-jp
���٤�, �ʲ��Τ褦�ʥڡ�������������ޤ�.
��������������Υ��饹���åɤξ����˽줿�����Ȥ��ɥ�����Ȥ� ȿ�Ǥ���Ƥ���Τ�ʬ����ޤ�.
RDoc �Υ��������Ϥ��ʤ꼫���˽��Ȥ��Ǥ��ޤ���, ���������ʽ������ǽ�ˤʤäƤ��ޤ�.
gphys_tone1.rb �˥����Ȥ��ɲä����ʲ��Υե������������ޤ��礦.
require "gphys_cont2" # #= GPhys �����Ѥ��ƿ��ɤ�ޤ����褹�륯�饹�饤�֥�� # #Authors:: ���� ���� #Version:: 1.2 2006-03-08 morikawa #Copyright:: Copyright (C) GFD Dennou Club, 2006. All rights reserved. #License:: Ruby �饤���˽�� # #-- (#-- ���� #++ �ޤǤ���ʬ�� RDoc �ϲ�ᤷ�ޤ���.) #"=", "==", ""===" �ϸ��Ф���ɽ���ޤ�. # #= ���Ф���٥�1 #== ���Ф���٥�2 #=== ���Ф���٥�3 #++ # #���Υ��饹�Υ����ѡ����饹�� GPhys_cont �Ǥ�. #new ��åɤǽ������Ԥ�, tone ��åɤ������Ԥ��ޤ�. # #-- # �⥸�塼��̾���å�̾�Ϥ��Τޤޥ⥸�塼����åɤؤΥ�� # �Ѵ�����ޤ�. #++ # #=== ���ͻ��� # #* http://ruby.gfd-dennou.org # 1. GPhys[http://www.gfd-dennou.org/library/ruby/products/gphys/] # 2. {2006 ǯ ��Ǿruby���ߥʡ�����Ǿdavis/ruby�������å�}[http://www.gfd-dennou.org/library/ruby/workshop200603/] # #-- #==�ꥹ�Ȥ�ɽ���˴ؤ��� # #�ꥹ�Ȥϰʲ��Τ褦�ʵ��椬�դ����ѥ饰��դǤ�. # # - '*' �⤷���� '-' �����̤Υꥹ�� # - ����+�ԥꥪ�ɤ��ֹ��դ��ꥹ�� # - ����ե��٥å�+�ԥꥪ�ɤǥ���ե��٥åȥꥹ�� # # #== ��˴ؤ��� # # http:, mailto:, ftp:, www. �ǻϤޤ�ƥ����Ȥϥ����֤ؤΥ���� # Ƚ�̤���ޤ�. # # label[url] �η����Ǥ�ϥ��ѡ����ĥ��ޤ�. ���ξ��� lavel ��ɽ # ������, url �������Ȥʤ�ޤ�. label ��ʣ����ñ���ޤ�Ǥ����� # (���ܸ�ξ��Ϥ��ä���ȤäƤ�������), ���̤�Ȥ�, <em>{multi word # label}[</em>url<em>]</em>�Ȥ��Ƥ�������. #++ # #=== ��ȯ���� # #* 1.2 2006-03-08 # * ��Ƿ�⤵��Υ����Ȥ�, ��Ԥ�饤����, ��ȯ����� # ������Ƥߤ�. # #* 1.1 2006-03-07 # * �Ȥꤢ�����������Ƥߤ�. # class GPhys_tone < GPhys_cont # �ޤ˿��ɤ��Ԥ����ɤ����Υե饰. # ���Υե饰�� false �� nil �ˤ������, GPhys_cont#cont �� # Ʊ�ͤ�ư��ޤ�. # attr_accessor :draw_tone # #=== ����������ѥ�å� # #GPhys_cont#new �Ȥ��Ƥ�������. # #-- # �̤Υ⥸�塼����Υ�åɤإ������� # "<i>�⥸�塼��̾</i>#<i>��å�̾</i>" �Ȼ��ꤷ�ޤ� #++ # def initialize super @draw_tone = true end #=== �����å� # #���ɤ�ޤ����褹���å�. �������ޤΤߤ����褷�������� #GPhys_cont#cont �����Ѥ��Ƥ�������. # #_itr_ :: ���褹��ݤ��Ͽ����ˡ����ꤷ�ޤ�. ���ͤ�Ϳ���Ƥ�������. # �ǥե���Ȥ� 1 �ˤʤäƤ��ޤ�. �ֹ�����ˡ�δط��˴ؤ��Ƥ� # http://www.gfd-dennou.org/library/dcl/dcl-f90/doc/term/2d.htm # �Ȥ������� # #�֤���:: ��� true ���֤�ޤ�. # def tone(itr=1) gphys = GPhys::IO.open(FILENAME, @var) DCL.gropn(1) ; DCL.sgpset('lcntl', false) ; DCL.uzfact(0.7) GGraph.set_fig( 'itr'=>(itr == nil) ? 1 : itr.to_i) GGraph.tone( gphys ) if @draw_tone GGraph.contour( gphys, !@draw_tone ) DCL.grcls return true end end if __FILE__ == $0 gphys = GPhys_tone.new gphys.tone end
�Ǥ�, ���� rdoc ���ޥ�ɤ�¹Ԥ��Ƥߤޤ��礦.
$ rdoc gphys_cont2.rb gphys_tone2.rb --main GPhys_tone --charset euc-jp
���٤�, �ʲ��Τ褦�ʥڡ�������������ޤ�.
�⥸�塼����åɤʤɤ˼�ưŪ�˥���Ϥ��, ���Ф�, �ꥹ��ɽ�� ���Ԥ��Ƥ��뤳�Ȥ��狼��ޤ�.
�����Τ���ν˴ؤ���, �����������ɤ˲��⤬�յ����Ƥ���Τǻ��Ȥ���
��������. ���ܤ��������, ���ͻ��� 1, 2 �� "MarkUp" ����ʬ��
�Ȥ��Ƥ�������. ��������������Dz��⤬����Ǥ��� '#--'
��
'#++'
����ʬ�˴ؤ��Ƥ� RDoc ��̵�뤹�뤿��, �ɥ�����Ȥ�ȿ�Ǥ�
��ޤ���.
rdoc ���ޥ�ɤΥ��ץ����Τ���, �嵭���������ʤ��ä������ʤ�Τ� �Ĥ��Ҳ𤷤ޤ�. ���ܤ��������, ���ͻ��� 1, 2 �� "Usage" �ޤ� �� "�Ȥ���" ����ʬ�Ȥ��Ƥ�������.
�ʲ��Υ��ޥ�ɤǺ��������ɥ�����Ȥ�ܤ��Ƥ����ޤ�. (���ޥ�ɥץ���ץȤ� DOS ������Ѥ��Ƥ����������ԥڤ��䤹���褦��, ���Ԥ��ʤ���Τ�ܤ��Ƥ����ޤ�)
$ rdoc gphys_cont2.rb gphys_tone2.rb --main GPhys_tone \ --charset euc-jp --inline-source --diagram \ --title "GPhys_tone and GPhys_cont Documentation" $ rdoc gphys_cont2.rb gphys_tone2.rb --main GPhys_tone --charset euc-jp --inline-source --diagram --title "GPhys_tone and GPhys_cont Documentation"
RDoc ���Ѥ��ƺ������줿�ɥ�����Ȥ��Ĥ��Ҳ𤷤ޤ�.