intellism / vscode-comment-translate

vscode 注释翻译插件, 不干扰正常代码,方便快速阅读源码。
https://marketplace.visualstudio.com/items?itemName=intellsmi.comment-translate
MIT License
487 stars 77 forks source link

当代码注释中包含代码块的时候,将代码也翻译了,效果很不理想 #237

Open tu6ge opened 1 day ago

tu6ge commented 1 day ago
截屏2024-09-20 15 51 05

截图是目前的效果,因为 rust 语言的注释中,可以包含代码,所以针对rust的代码块能不能做下区分呢,别翻译这块呢

tu6ge commented 1 day ago

原始内容如下

//! Value must be a valid email address, supported `String`, and other types always return false.
//!
//! # Examples
//! ```
//! # use serde::Serialize;
//! # use valitron::{available::{Email, MessageKind}, Validatable, Validator};
//! #[derive(Serialize, Debug)]
//! struct Input {
//!     email: String,
//!     password: String,
//! }
//!
//! let input = Input {
//!     email: String::from("user"),
//!     password: String::default(),
//! };
//! let err = input
//!     .validate(
//!         Validator::new()
//!             .rule("email", Email)
//!     )
//!     .unwrap_err();
//!
//! assert!(matches!(
//!     err.get("email").unwrap()[0].kind(),
//!     MessageKind::Email
//! ));
//!
//! let input = Input {
//!     email: String::from("user@example.com"),
//!     password: String::from("bar"),
//! };
//! input
//!     .validate(
//!         Validator::new()
//!             .rule("email", Email)
//!     )
//!     .unwrap();
//! ```

rust代码的注释也可能是这种情况

/// ```
/// let a = "foo";
/// ```

我可以参与代码贡献,但是我现在看到代码里注释很少,如果可以的话,可以提供一些思路,或者方向,我自己完成这块的改进

intellism commented 1 day ago

收到,注释内的代码判断目前做的比较粗糙。只是简单判断了下,是否跳过翻译。 后续优化下Rust的代码判断。

intellism commented 1 day ago

原始内容如下

//! Value must be a valid email address, supported `String`, and other types always return false.
//!
//! # Examples
//! ```
//! # use serde::Serialize;
//! # use valitron::{available::{Email, MessageKind}, Validatable, Validator};
//! #[derive(Serialize, Debug)]
//! struct Input {
//!     email: String,
//!     password: String,
//! }
//!
//! let input = Input {
//!     email: String::from("user"),
//!     password: String::default(),
//! };
//! let err = input
//!     .validate(
//!         Validator::new()
//!             .rule("email", Email)
//!     )
//!     .unwrap_err();
//!
//! assert!(matches!(
//!     err.get("email").unwrap()[0].kind(),
//!     MessageKind::Email
//! ));
//!
//! let input = Input {
//!     email: String::from("user@example.com"),
//!     password: String::from("bar"),
//! };
//! input
//!     .validate(
//!         Validator::new()
//!             .rule("email", Email)
//!     )
//!     .unwrap();
//! ```

rust代码的注释也可能是这种情况

/// ```
/// let a = "foo";
/// ```

我可以参与代码贡献,但是我现在看到代码里注释很少,如果可以的话,可以提供一些思路,或者方向,我自己完成这块的改进

思路:在这里判断注释内是否包含代码,如何是原文显示还是跳过翻译:https://github.com/intellism/vscode-comment-translate/blob/ee1b0fe21e70f2e2829961fe25e6a7cb91263a07/src/languageFeature/decoration.ts#L248