ruby-list

　ひだかです。

At 2002/02/27 01:35:25 jihg wrote:
> jihg です。
> 
> ◆作成者側
>   1.僕は日本語しか分からないので、コメントは日本語で書きたい。
>   2.で、作成者(僕）と利用者（誰か）の理解できる言葉が違うとき、利用者が
> 理解しやすいように、そっちの言葉のコメントも用意したい。
>   3.そうするためにはどうしたらいいか？
>   4.コメント部分を別ファイルに抜き出す。
>   5.拡張子は、例えば英語なら、元ファイル名.rdoc.en
>   6.ファイルは対訳形式で、行ごとに原文と訳文を併記する。
>   7.ひとまとめにして配布する。

　だいたいイメージは同じだとおもうのですが、

・RAAに登録するもの・Ruby本体に添付するものには英語でコメントを
  書きましょう

という前提があると思います。だからこそ、本体は英語で、別ファイルに
日本語ドキュメントを書きたい、と思ったわけです。

　あと細かいところですが、6.の「行ごとに」というのは、ぼくとしては
段落単位くらいを考えていました。

> で、思うんだけど、元のスクリプトのコメントを直接置き換えてみるのはどう？
> ソースを読む人の助けになりそうなんだけど。
> ※問題は、パッチを提供する場合。ちょっと面倒。

　置き換えるツールは便利なんですけど、やっぱり他人の配布物に手を入れて
しまうとあとで困りそうなので、手元で勝手に置き換えるために使うのが
よさそうだと思っています。

　あと、手元で試行錯誤している段階では日本語でコメントを書いていて、
配布するぞ！と思った段階で英語に直したりするので（←これが間違い？）
入れ替えツール自体は個人的には日本語→英語方向で使うのかも。

# それより配布できるレベルのものをさっさと作りなさいって
# 感じでもありますが(>_<)

> ＞このくらいやると使いやすくなるでしょうか。まだまるっきり妄想ですが。
> ＞でも、こんなに複雑なら、最初から一体化して書いたほうがましなのかな。
> 対応する言葉が多くなるとコメントが肥大化する。そうなると、英語に統一すれ
> ばいいってはなしが出てくる。併記する必要ある？ って話。

　英語をちゃんと読み書きできるようになりましょう、というのは
そのとおりだとは思うんですけどね(-_-;;;

> RDoc はフォントは考慮しないだろうから、こういうことができるし。一本化す
> るより別ファイルにしたほうが、より多くの言葉に対応できていいんじゃな
> い？。

　一本化したほうが書きやすい、というのも間違いないとも思うので
迷うところです。。

-- 
ひだかたかひろ

Thread

Prev Next

In This Thread

Prev Next

[#33716] Re: set_path_for_r — "HAYAMA_Kaoru" <iyamatta.hayama@...>

[#33718] mod_ruby and letmesee... — Kazuhiko <kazuhiko@...>

[#33727] Cygwin で Ruby-GD-0.7.4 インストール？ — "井上 浩一" <kyoui32@...>

[#33731] [ANN] TMail 0.10.1 — Minero Aoki <aamine@...>

[#33732] 文字列の式展開について — Masao Mutoh <mutoh@...>

[#33736] Redefinition of builtin class — Shin-ichiro HARA <sinara@...>

[#33740] Net::SMTP.start の引数 — URA Takefumi <hage@...>

[#33757] [ANN] MySQL/Ruby Windows package(2.4.1-1) — "TAMURA.KENICHI" <sgs02516@...>

[#33762] WebDAV client — HIDAKA Takahiro <cv8t-hdk@...>

[#33783] [ANN] RubyCocoa 0.2.6 — FUJIMOTO Hisakuni <hisa@...>

[#33785] NET:HTTP get2 のエラー回避 — Takashi Hoshizawa <t_hoshizawa@...>

[#33791] 1.6.6 ref manual typo? — AOKI Yoshihiro <aoki@...>

[#33793] 右辺の値なしでも実行可能？ — "井上 浩一" <kyoui32@...>

[#33795] Re: 右辺の値なしでも実行可能？ — "井上 浩一" <kyoui32@...>

[#33802] Re: 右辺の値なしでも実行可能？ — "井上 浩一" <kyoui32@...>

[#33807] Re: 右辺の値なしでも実行可能？ — "井上 浩一" <kyoui32@...>

[#33827] ruby-postgres, PGconn.async_exec — m_seki@...

[#33832] [win32]ScriptControl — KANEKO Naoshi <wbs01621@...>

[#33838] 'tag' target of Makefile made by mkmf.rb for TAGS and tags file — NISHIMATSU Takeshi <t-nissie@...>

[#33844] No >2GB support ? — "Oliver M . Bolzer" <oliver@...>

[#33846] quickml サーバ — Satoru Takabayashi <satoru@...>

[#33848] ｘｘとして出し入れするメソッドの名前は？ — Take_tk <ggb03124@...>

[#33889] Ruby スクリプトサーバ + アプリと Apache+CGI アプリ — "井上 浩一" <kyoui32@...>

[#33893] Re: Ruby スクリプトサーバ + アプリと Apache+CGI アプリ — "井上 浩一" <kyoui32@...>

[#33906] Re: Ruby スクリプトサーバ + アプリと Apache+CGI アプリ — "井上 浩一" <kyoui32@...>

[#33915] Re: Ruby スクリプトサーバ + アプリと Apache+CGI アプリ — "井上 浩一" <kyoui32@...>

[#33916] Walrus/OBAQ メーリングリスト — Taku Nakajima <tnakajima@...>

[#33926] 破壊的な代入について — Himuro UTO <himuro-uto@...>

[#33941] [watch] 情処 FI&DD 2002-3-15 — Noritsugu Nakamura <nnakamur@...>

[#33954] [PATCH] ruby-mode.el fontification & rescue modifier — nobu.nakada@...

[#33959] Re: Ruby スクリプトサーバ + アプリと Apache+CGI アプリ — "井上 浩一" <kyoui32@...>

[#33962] Re: Ruby スクリプトサーバ + アプリと Apache+CGI アプリ — "井上 浩一" <kyoui32@...>

[#33964] pdflib-0.7 PDF クラスの継承について — "Makoto Matsukawa" <racer-m@...>

[#33966] 「たまてばこ」開発版が SecurityE rror — dellin <dellin@...>

[#33975] rescue exception raise in load — Kazuhiro Yoshida <moriq.kazuhiro@...>

[#33988] FileTest.exist?("") の値の UNIX と Windows との違い — Akira Suzuki <a-suzuki@...>

[#33994] Shell#expand_path に ~ の入ったパスを渡したとき — Hiroshi Saito <HiroshiSaito@...>

[#33997] JOLT award — matz@... (Yukihiro Matsumoto)

[#34003] Bignum と負の Fixnum の bit 和について — ISAMU KOZUKA <kozuka@...>

[#34006] for_fd したソケットの close — HIRATA Naoto <hirata-naoto@...>

[#34010] si-bu-ra-gu — MAP2303@...

[#34012] [] について — Tadashi Oh-Ya <toy@...>

[#34015] 現在使用中の ruby.dll のパスは分かりますか？。 — Take_tk <ggb03124@...>

[#34021] localized document — HIDAKA Takahiro <cv8t-hdk@...>

[#34023] RDTool で箇条書きの後に pre 要素 — "Yasushi Oka" <oka@...>

[#34028] Re: RDTool で箇条書きの後に pre 要素 — "Yasushi Oka" <oka@...>

[#34030] Ruby Gem Box — Noritsugu Nakamura <nnakamur@...>

[#34037] 左辺項が１つの時の多重代入 — "Shirai,Kaoru" <shirai@...1jp.com>

[#34044] クラスメソッドの呼び出し元 — Takashi SUGA <suchowan@...>

[#34046] Cygwin 版で拡張ライブラリの拡張子が so などのファイルはどのディレクトリにはいるのでしょうか？ — "井上 浩一" <kyoui32@...>

[#34050] nil.to_f — ABE Shigeru <shiger-a@...>

[#34053] 漢数字 -> 数 — TOYOFUKU Chikanobu <toyofuku@...>

[#34056] ruby-dev summary — TAKAHASHI Masayoshi <maki@...>

[#34087] already initialized constant — 島田喜郎 <shimada@...>

[#34107] File#pos とファイルへの書き込み位置との整合性 — 堀川 久 <vzw00011@...>

[#34121] date3 in date2 — "NAKAMURA, Hiroshi" <nakahiro@...>

[#34127] singleton class and anonymous class — matz@... (Yukihiro Matsumoto)

[ruby-list:34097] Re: localized document

Thread

In This Thread

[#33727] Cygwin で Ruby-GD-0.7.4 インストール？ — "井上浩一" <kyoui32@...>

[#33793] 右辺の値なしでも実行可能？ — "井上浩一" <kyoui32@...>

[#33795] Re: 右辺の値なしでも実行可能？ — "井上浩一" <kyoui32@...>

[#33802] Re: 右辺の値なしでも実行可能？ — "井上浩一" <kyoui32@...>

[#33807] Re: 右辺の値なしでも実行可能？ — "井上浩一" <kyoui32@...>

[#33889] Ruby スクリプトサーバ + アプリと Apache+CGI アプリ — "井上浩一" <kyoui32@...>

[#33893] Re: Ruby スクリプトサーバ + アプリと Apache+CGI アプリ — "井上浩一" <kyoui32@...>

[#33906] Re: Ruby スクリプトサーバ + アプリと Apache+CGI アプリ — "井上浩一" <kyoui32@...>

[#33915] Re: Ruby スクリプトサーバ + アプリと Apache+CGI アプリ — "井上浩一" <kyoui32@...>

[#33959] Re: Ruby スクリプトサーバ + アプリと Apache+CGI アプリ — "井上浩一" <kyoui32@...>

[#33962] Re: Ruby スクリプトサーバ + アプリと Apache+CGI アプリ — "井上浩一" <kyoui32@...>

[#34046] Cygwin 版で拡張ライブラリの拡張子が so などのファイルはどのディレクトリにはいるのでしょうか？ — "井上浩一" <kyoui32@...>

[#34107] File#pos とファイルへの書き込み位置との整合性 — 堀川久 <vzw00011@...>