-
Notifications
You must be signed in to change notification settings - Fork 85
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
247 additions
and
114 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,40 +1,81 @@ | ||
# VSCode 注释翻译 | ||
# VSCode Comment Translation Extension | ||
|
||
[![Licence](https://img.shields.io/github/license/intellism/vscode-comment-translate.svg)](https://github.com/intellism/vscode-comment-translate) | ||
This extension helps developers translate comments, strings, code hints, error messages, and variable names in their code. | ||
|
||
## 简介 | ||
![Licence](https://img.shields.io/github/license/intellism/vscode-comment-translate.svg) | ||
|
||
[【English】](./doc/README.md) [【日本語の文書】](./doc/README_JA.md) [【한국어】](./doc/README_KR.md) | ||
## Introduction | ||
[【中文文档】](./doc/README_ZH.md) [【日本語の文書】](./doc/README_JA.md) [【한국어】](./doc/README_KR.md) | ||
|
||
许多优秀的项目,都有丰富的注释,使用者可以快速理解代码意图。但是如果使用者并不熟习注释的语言,会带来理解困难。 | ||
本插件使用 Google、Bing、Baidu、AliCloud、DeepL等的 Translate API 翻译 VSCode 的编程语言的注释。 | ||
Many excellent projects have extensive comments to help users quickly understand the code's intent. If users are not familiar with the language of the comments, it can be challenging to understand. This extension provides multiple translation scenarios to help developers comprehend and write multilingual code more easily. It supports common translation services like Google, Bing, AliCloud, and DeepL, and allows developers to add custom translation services. | ||
|
||
![Introduction](./doc/image/Introduction.gif) | ||
|
||
## Features | ||
|
||
## 功能 | ||
1. Hover识别并翻译代码中注释部分。支持不同语言,单行、多行注释。 | ||
2. Hover翻译选中区域文本(划词翻译) | ||
3. 翻译并快速替换选中文本 | ||
4. 翻译并替换文件中所有"字符串"或"注释" | ||
* 如果有选中的文本区域,只识别并翻译替换选中区域的“字符串”或“注释” | ||
5. 翻译Hover内容。(实验功能) | ||
|
||
## 配置 | ||
* `commentTranslate.hover.enabled`: 开启/关闭悬停翻译(可以通过状态快速设置) | ||
* `commentTranslate.hover.concise`: 开启/关闭简洁模式.开启后只有按住ctrl或command才会触发悬浮翻译 | ||
* `commentTranslate.hover.string`: 开启/关闭字符串悬停翻译 | ||
* `commentTranslate.hover.content`: 开启/关闭翻译悬停内容 | ||
* `commentTranslate.multilineMerge`: 合并多行注释 | ||
* `commentTranslate.targetLanguage`: 翻译目标语言,没有设置的情况下使用vscode本地语言。(可以通过状态快速设置) | ||
* `commentTranslate.source`: 翻译服务源配置。建议通过命令完成设置。 支持插件扩展翻译服务源。 [example](https://github.com/intellism/deepl-translate) | ||
* `commentTranslate.maxTranslationLength`, 最长翻译长度配置。规避过长字符翻译引起收费过多问题 | ||
* `commentTranslate.googleTranslate.mirror`,解决国内服务不可访问问题. [文档](https://hcfy.app/blog/2022/09/28/ggg#%E6%96%B9%E6%A1%88-c%E4%BD%BF%E7%94%A8%E9%95%9C%E5%83%8F%E5%9C%B0%E5%9D%80%E6%9C%80%E7%AE%80%E5%8D%95) | ||
|
||
## 翻译源 | ||
* 支持外部“翻译源”扩展。目前外部插件已支持: | ||
* [ChatGPT 支持反代 API](https://marketplace.visualstudio.com/items?itemName=upupnoah.chatgpt-comment-translateX) | ||
* [ChatGPT](https://marketplace.visualstudio.com/items?itemName=kitiho.chatgpt-comment-translate) | ||
* [DeepL](https://marketplace.visualstudio.com/items?itemName=intellsmi.deepl-translate) | ||
* [Tecent Cloud](https://marketplace.visualstudio.com/items?itemName=Kaiqun.tencent-cloud-translate) | ||
* 已内置Ali翻译源。 可以通过 [开通阿里云机器翻译](https://www.aliyun.com/product/ai/alimt) 生成 accessKeyId & accessKeySecret ,并配置到插件中。切换对应翻译源,获得更稳定的翻译服务 | ||
### Code Reading | ||
The extension identifies multilingual content like comments and strings in the source code using TextMate, translates them quickly, and displays them via Hover, minimizing disruption to development. | ||
|
||
**Hover Translation**: Move the mouse over comments, strings, or selected areas to see the translated content in a hover box. Other hover content like exceptions and code documentation are also translated and displayed. | ||
|
||
**Immersive Reading**: Turn on immersive comment translation to automatically translate comments and display them in the document. The translated results can be shown alongside the original text or in place of it; toggle the display mode with `Ctrl+Shift+B`. | ||
![Immersive](./doc/image/Immersive.gif) | ||
|
||
### Translation and Replacement | ||
The extension can translate source code content and quickly replace it in the document. For instance, translate a description and use it as a variable name; in multilingual development scenarios, translate a string and replace it in the document. | ||
|
||
**Translate Variable Naming**: Translate the current description into English and provide various variable names to choose from, then replace the original description. | ||
![naming](<./doc/image/full naming.gif>) | ||
|
||
**Hover Replacement**: The hover box provides the ability to replace text with the translation result, which replaces the original content. | ||
![hover](./doc/image/hover_image.png) | ||
|
||
**Full Text Replacement Translation**: Supports translating and replacing strings, comments, and selected areas with one click. | ||
![replace](./doc/image/replace.png) | ||
|
||
### GitHub Copilot Chat Participant: @translate | ||
> - Requires pre-installation of the GitHub Copilot Chat extension and authorization. | ||
> - For GitHub Copilot users, translation is currently supported in the Chat box, but not for comments, text, etc. | ||
This extension extends GitHub Copilot by enabling translations in the Chat box using Copilot's AI model. The target language is set by CommentTranslate. Select text in the Editor and send it to GitHub Copilot Chat for quick translation using commands. | ||
![copilot](./doc/image/copilot.gif) | ||
|
||
## Useful Commands | ||
|
||
> Mac: `ctrl+shift+?` / Windows: `alt+shift+?` | ||
The extension provides translation or replacement commands for various scenarios, with shortcuts for some common functionalities. Users can also customize shortcuts according to their habits. | ||
- **Immersive Comment Translation**: Toggle immersive translation reading for the current document `ctrl+shift+z` | ||
- **Immersive Display Mode**: Toggle cross-display/placeholder read mode `ctrl+shift+b` | ||
- **Translate Variable Naming**: Translate the current descriptive word and provide named variables `ctrl+shift+n` | ||
- **Translation and Replacement**: Translate selected content and replace it at the current location `ctrl+shift+t` | ||
- **Copilot Quick Translation**: Translate selected content or clipboard content in GitHub Copilot Chat `ctrl+shift+y` | ||
|
||
## Translation Services | ||
|
||
The extension supports the following translation services: | ||
- **Google Translate**: Built-in, free version, used by default. | ||
- **Note**: Requires a network connection, some users may need a proxy. If encountering network issues, it is recommended to use Bing. | ||
- **Bing Translate**: Built-in, free version. | ||
- **AliCloud Translate**: Built-in, requires configuration of accessKeyId & accessKeySecret. | ||
|
||
Third-party translation services can be found by searching for `@tag:translateSource` in the plugin market. Users can choose the desired translation service through the plugin configuration or expand it by customizing the translation service. [More Links](https://github.com/intellism/vscode-comment-translate/wiki/Translation-Service) | ||
|
||
## Common Configurations | ||
* `commentTranslate.hover.enabled`: Enable/disable hover translation (quickly set through status) | ||
* `commentTranslate.hover.concise`: Enable/disable concise mode. Only triggers hover translation when pressing ctrl or command | ||
* `commentTranslate.hover.string`: Enable/disable string hover translation | ||
* `commentTranslate.hover.content`: Enable/disable translation of hover content | ||
* `commentTranslate.multilineMerge`: Merge multiline comments | ||
* `commentTranslate.targetLanguage`: Translation target language, uses the local VSCode language if not set (quickly set through status) | ||
* `commentTranslate.source`: Translation service source configuration. It is recommended to set it through commands. Supports plugin extensions for translation service sources. [example](https://github.com/intellism/deepl-translate) | ||
* `commentTranslate.maxTranslationLength`: Maximum translation length configuration to avoid excessive charges for long character translations | ||
* `commentTranslate.browse.enabled`: Enable/disable project immersive browsing translation function | ||
|
||
|
||
## Support Us | ||
|
||
If you find this extension helpful, please consider supporting us in the following ways: | ||
- Give us a star on GitHub [intellism/vscode-comment-translate](https://github.com/intellism/vscode-comment-translate) | ||
- Submit feedback and suggestions | ||
- Share with your friends and colleagues |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,37 +1,80 @@ | ||
# VSCode 注釈翻訳 | ||
# VSCode コメント翻訳プラグイン | ||
|
||
## 前書き | ||
[【English】](./README.md) [【中文文档】](../README.md) [【한국어】](./README_KR.md) | ||
このプラグインは、開発者がコード内のコメント、文字列、コードヒント、エラーメッセージ、変数名などの内容を翻訳するのを支援します。 | ||
|
||
多くの優れたプロジェクトには多くのアノテーションがあり、ユーザーはコードの意図をすばやく理解することができます。 しかし、ユーザが注釈付き言語に精通していないと、理解が困難になります。 このプラグインは、Google Translate APIを使用してVSCodeプログラミング言語のコメントを翻訳します。 | ||
![Licence](https://img.shields.io/github/license/intellism/vscode-comment-translate.svg) | ||
|
||
## 紹介 | ||
[【English】](../README.md) [【中文文档】](./README_ZH.md) [【한국어】](./README_KR.md) | ||
|
||
## v1.5.0 更新 | ||
* baiduとbingの翻訳ソースを追加します。同じIPGoogleでの翻訳が多すぎるとアクセスが制限され、一時的に他の翻訳ソースに切り替えることができます。 | ||
* 翻訳のターゲット言語オプションを増やす [Google Language support](https://cloud.google.com/translate/docs/languages) | ||
* 「翻訳の置き換え」、翻訳の対象言語を選択し、ショートカットキーを追加します control + shift + t | ||
多くの優れたプロジェクトには豊富なコメントがあり、ユーザーがコードの意図を迅速に理解するのに役立ちます。ユーザーがコメントの言語に慣れていない場合、理解が難しくなります。このプラグインは多くの翻訳シナリオを提供し、開発者が多言語コードをより簡単に理解し、作成するのを支援します。プラグインはGoogle、Bing、AliCloud、DeepLなどの一般的な翻訳サービスをサポートし、開発者がカスタム翻訳サービスを追加することもできます。 | ||
|
||
## 特徴 | ||
1. 読むことを妨げることなくコードのコメント部分を特定する。 さまざまな言語、1行、複数行のコメントをサポートします | ||
![Introduction](./image/ja/Introduction.gif) | ||
![Introduction](./image/Introduction.gif) | ||
|
||
2. ハンプ分割をサポートするためのユーザー文字列と変数変換のサポート | ||
![Introduction](./image/cn/variable.gif) | ||
## 機能 | ||
|
||
3. 最後の翻訳エリアを選択 | ||
![Introduction](./image/cn/select.gif) | ||
### コードリーディング | ||
プラグインはTextMateを使用してソースコード内のコメント、文字列などの多言語コンテンツを識別し、迅速に翻訳してHoverで表示し、開発への干渉を最小限に抑えます。 | ||
|
||
4. 選択の翻訳と置換 | ||
![Introduction](./image/translate-selections.gif) | ||
**Hover翻訳**: コメント、文字列、または選択範囲にマウスを移動すると、翻訳された内容がホバーで表示されます。他のホバーコンテンツ(例外、コードドキュメントなど)がある場合も翻訳されて表示されます。 | ||
|
||
5. 選択範囲翻訳 | ||
![Introduction](./image/cn/selection.gif) | ||
**没入型リーディング**: 没入型コメント翻訳をオンにすると、コメントが自動的に翻訳され、ドキュメントに表示されます。翻訳結果を原文と対照して表示するか、プレースホルダーとして表示するかを設定やショートカットキー`Ctrl+Shift+B`で切り替えることができます。 | ||
![Immersive](./image/Immersive.gif) | ||
|
||
## 設定オプション | ||
#### 多言語サポート | ||
ターゲット言語をすばやく設定するためのステータスバー [Google Language support](https://cloud.google.com/translate/docs/languages) | ||
![Multi-language](./image/cn/status-bar.gif) | ||
### 翻訳と置換 | ||
プラグインはソースコード内の内容を翻訳するだけでなく、翻訳された内容をドキュメントに迅速に置換することもサポートします。例えば、説明を翻訳して変数名として使用する場合や、多言語開発シナリオで文字列を翻訳してドキュメントに置換する場合などです。 | ||
|
||
**変数命名の翻訳**:現在の説明を英語に翻訳し、さまざまな変数名を提供します。選択すると元の説明が置換されます。 | ||
![naming](<./image/full naming.gif>) | ||
|
||
#### 複数行のコメントをマージする(ソース言語は英語のみサポート) | ||
![Multi-line-merge](./image/multi-line-merge.gif) | ||
**Hover置換**: ホバー表示された翻訳ボックスで置換機能を提供し、選択すると翻訳結果が元の内容に置換されます。 | ||
![hover](./image/hover_image.png) | ||
|
||
**全文置換翻訳**:文字列、コメント、選択範囲をサポートし、ワンクリックで全文を翻訳テキストに置換します。 | ||
![replace](./image/replace.png) | ||
|
||
### GitHub Copilot Chat Participant: @translate | ||
> - 事前にGitHub Copilot Chatプラグインをインストールし、その認可を受ける必要があります。 | ||
> - GitHub Copilotユーザー向けに、現在はChatボックス内での翻訳をサポートしており、コメントやテキストなどの内容の翻訳にはこの機能を使用できません。 | ||
このプラグインはGitHub Copilotを拡張し、Chatボックス内で`@translate`を使用して翻訳を行うことができます。Copilotが提供するAI大モデルを使用してテキストを翻訳し、翻訳先の言語はCommentTranslateの設定されたターゲット言語になります。エディター内でテキストを選択した後、コマンドを使用して迅速にGitHub Copilot Chatに送信して翻訳することができます。 | ||
![copilot](./image/copilot.gif) | ||
|
||
## 有用なコマンド | ||
|
||
> Mac: `ctrl+shift+?` / Windows: `alt+shift+?` | ||
プラグインはさまざまなシナリオの翻訳や置換コマンドを提供しており、一部の一般的な機能にはショートカットキーが設定されています。ユーザーは自分の習慣に応じてショートカットキーをカスタマイズすることもできます。 | ||
- **没入型コメント翻訳**:現在のドキュメントの没入型翻訳リーディングをオン/オフ `ctrl+shift+z` | ||
- **没入型表示方法**:対照/プレースホルダーリーディング方法を切り替え `ctrl+shift+b` | ||
- **変数命名の翻訳**:現在の説明語を翻訳して変数名を提供 `ctrl+shift+n` | ||
- **翻訳置換**:選択した内容を翻訳して現在の位置に置換 `ctrl+shift+t` | ||
- **Copilot クイック翻訳**:選択した内容またはクリップボードをGitHub Copilot Chatで翻訳 `ctrl+shift+y` | ||
|
||
## 翻訳サービス | ||
|
||
このプラグインは以下の翻訳サービスをサポートしています: | ||
- **Google 翻訳**: 内蔵、無料版。 デフォルトで使用 | ||
- **注**:ネットワーク要件があり、一部のユーザーはプロキシが必要です。ネットワークの問題が発生した場合は、Bingの使用をお勧めします。 | ||
- **Bing 翻訳**: 内蔵、無料版。 | ||
- **AliCloud 翻訳**: 内蔵、accessKeyId & accessKeySecretの設定が必要です。 | ||
|
||
サードパーティが提供する翻訳サービスは、プラグインマーケットで`@tag:translateSource`を検索して見つけることができます。ユーザーはプラグイン設定を通じて使用する翻訳サービスを選択するか、カスタム翻訳サービスを拡張することができます。 [詳細リンク](https://github.com/intellism/vscode-comment-translate/wiki/Translation-Service) | ||
|
||
## 一般的な設定 | ||
* `commentTranslate.hover.enabled`: ホバー翻訳のオン/オフ(ステータスで迅速に設定可能) | ||
* `commentTranslate.hover.concise`: 簡潔モードのオン/オフ。オンにすると、ctrlまたはcommandを押したときにのみホバー翻訳がトリガーされます。 | ||
* `commentTranslate.hover.string`: 文字列ホバー翻訳のオン/オフ | ||
* `commentTranslate.hover.content`: 翻訳ホバーコンテンツのオン/オフ | ||
* `commentTranslate.multilineMerge`: 複数行コメントのマージ | ||
* `commentTranslate.targetLanguage`: 翻訳ターゲット言語。設定がない場合はvscodeのローカル言語を使用します。(ステータスで迅速に設定可能) | ||
* `commentTranslate.source`: 翻訳サービスソースの設定。コマンドを通じて設定することをお勧めします。 プラグイン拡張翻訳サービスソースをサポートします。 [例](https://github.com/intellism/deepl-translate) | ||
* `commentTranslate.maxTranslationLength`: 最大翻訳長の設定。過長文字列の翻訳による過剰な料金を回避します。 | ||
* `commentTranslate.browse.enabled`: プロジェクト没入ブラウズ翻訳機能のオン/オフ | ||
|
||
## サポート | ||
|
||
このプラグインが役に立ったと思ったら、以下の方法でサポートを検討してください: | ||
- GitHubでスターを付ける [intellism/vscode-comment-translate](https://github.com/intellism/vscode-comment-translate) | ||
- フィードバックや提案を送る | ||
- 友人や同僚にシェアする |
Oops, something went wrong.