XML ドキュメント コメント(英語)を日本語で読む方法を考える
(ソフトウェア開発者向け広告)
豚汁単品を合計5,000円以上お買い上げいただいた方に
先着60オーダー限定で「Technology Company」ステッカーをプレゼント!
Visual Studioでの開発では NuGet パッケージをよく利用する。
NuGetでインストールしたライブラリは、オブジェクトブラウザで確認するとコメントが英語であることは多い。
外国人が作成されたライブラリなら英語。
◆ (例)英語のコメント
Visual Studioオブジェクトブラウザで「StackExchange.Redis」を確認
外国産の便利なライブラリを日本人が使いやすい状態にしてみたいものだ。
ライブラリの使い方が分かりやすくなれば、実現できることも多くなるはずだ。
そこで、XMLコメント(英語)の日本語訳を一括で追記するツールを作成してみた。
日本語訳を追記する手順は以下の通り。
<手順>
①作成したツールを使って「必要なXMLコメント」を全てhtmlファイルに出力する。
→ summary、param、remarks、returns のコメントを全てhtmlファイルに出力する。
②出力したhtmlファイルをGoogle Chromeで開き、日本語翻訳させる。
③Google Chromeで日本語翻訳した文章をコピー&ペーストして新規テキストファイルを作成する。
④作成したテキストファイルの日本語の文章をツールで読み込み、XMLファイルに追記する。
※①と④をツールで行う。②と③は手動で行う。
◆(例)日本語訳を追記したコメントー下図の赤枠が追記した箇所
Visual Studioオブジェクトブラウザで「StackExchange.Redis」を確認
だいぶ分かりやすくなった。初めましての外国産ライブラリを扱う際のハードルが下がった。
しかし、英語も読めた方がよいので、英語を日本語に置き換えるのではなく、
英語をそのまま残して、日本語を追記するようにした。
Google Chromeの翻訳はおかしなところも多少あったが、雰囲気で読める日本語。
◆(例)summary(概要)のコメント 1,335箇所 ーExcelに貼り付けて確認。
・
・
・