ククログ

株式会社クリアコード > ククログ > 国際化サポート付きのYARD 0.8.0がリリース

国際化サポート付きのYARD 0.8.0がリリース

Ruby用のドキュメンテーションツールであるYARD 0.8.0がリリース(英語)されました。0.8.0でついに国際化サポートが入りました!

0.8.0ではタグまわりの改良やMix-inしているモジュールもクラスのドキュメントの中に一緒に入れられる改良1などたくさんの改良がありますが、その中の1つとして国際化サポートが追加されています。

国際化サポートの追加といっても、まだ、ドキュメントから翻訳対象のメッセージを抽出する機能があるだけです2。メッセージを翻訳し、それを使って英語のドキュメントから日本語のドキュメントを生成する機能などはまだありません。そのため、今すぐ一気に便利になるわけではありません。しかし、これまで国際化をサポートしたRuby用のドキュメンテーションツールがなかったので、これは大きな一歩です。不足している機能についてはこれからもpull requestを送って徐々に追加してもらう予定です。

Python用のドキュメンテーションツールであるSphinx3も国際化のサポートが進んでいます。Ruby用のドキュメンテーションツールであるYARDでも国際化のサポートが進み、より多くの人が母国語でRubyのライブラリのドキュメントを読めるようになるとよいですね4

  1. Railsまわりのライブラリなど、たくさんのモジュールをMix-inしているような場合に便利そう。

  2. 抽出したメッセージはPOTファイルとして出力します。

  3. Python以外にもgroongaなどで使われていたりと、広く使われています。

  4. ドキュメンテーションツールが国際化をサポートする以外に、機械翻訳をがんばるという方法もあります。