Skip to content
This repository has been archived by the owner on Nov 10, 2023. It is now read-only.

邦訳のルール

OrgaChem edited this page Nov 16, 2013 · 12 revisions
  1. 邦訳の着手時に issue で自分をアサイン
  2. HTML+JsDoc によるマークアップを Markdown 記法に修正
  3. 内容はなるべく忠実に
  4. private なものは邦訳しないでもOK(ただ、可能であればやってほしい)
  5. JsDoc 以外のコメントは邦訳しないでもOK(ただ、可能であればやってほしい)

邦訳の着手時に issue で自分をアサイン

邦訳に着手する際には、該当するファイルの issue に自分をアサインしてください。また、既に他の人がアサインされているファイルは邦訳しないでください。

また、邦訳を途中でやめたい場合は issue にその旨をコメントした後、自分のアサインを外してください。

HTML+JsDoc によるマークアップはMarkdownに

従来のマークアップはソースコードの状態では読みづらいため、ソースコードでも読みやすい Markdown 記法を採用しています。 @code@link<pre><code><a> のかわりにバッククォート(`)で囲んでください。

また、マークアップされていないコード・式・値・リンクを示す場合にも、適宜 Markdown 記法に変換してください。

例1:JsDoc マークアップ

Lorem {@code Ipsum}.

Lorem `Ipsum` 。

例2:マークアップされていない値

Lorem Ipsum returns true.

Lorem Ipsum は `true` を返す。

例3:HTML マークアップ

<pre>
foo.bar();
</pre>

(バッククォート3つ)
foo.bar()
(バッククォート3つ)

例4:リンク

See {@link http://example.com}.

`http://example.com` を見てください。

内容はなるべく忠実に

翻訳内容はなるべく忠実にしてください。 邦訳する際にどうしてもわかりづらくなってしまう場合のみ、内容を付け足してください。 たとえば、リンクのURLを日本語の文献のものへと差し替えていはいけません。