RStudio Comment Reflow 0.1.1

RStudio Comment Reflow：VS Code扩展，智能注释重排功能

RStudio Comment Reflow扩展将RStudio的注释重排功能引入Visual Studio Code，为开发者提供智能的注释重排解决方案。此扩展不仅支持R语言，还适用于Python、TypeScript/JavaScript等多种编程语言，能够智能处理Roxygen文档、Markdown代码块以及列表项目，确保代码注释在编辑器中始终保持最佳可读性和结构。

主要功能：

• 智能重排注释： 根据编辑器的自动换行列宽度调整注释长度，使其更加整齐美观。
• 保留Roxygen文档格式： 确保Roxygen文档标签和格式不被破坏，维护文档结构的完整性。
• 处理Markdown代码块： 识别并跳过Markdown代码块内的内容，避免不必要的重排。
• 保持列表项目： 保留列表项目和子弹点，确保列表结构清晰。
• 多语言支持： 适用于R、Python、TypeScript/JavaScript等多种编程语言。
• 保持原有缩进和前缀： 保留注释的原有缩进和前缀，确保代码风格的一致性。

使用方法：

1. 将光标置于注释块内或选中多行注释。
2. 按下Ctrl Shift '，注释将自动重排以适应编辑器的自动换行列宽。

配置：

此扩展利用VS Code的editor.wordWrapColumn设置来确定最大行长度，您可以通过VS Code设置进行调整：

{
    "editor.wordWrapColumn": 80
}

支持的注释类型：

• R/Python风格的注释（#）
• JavaScript/TypeScript风格的注释（// 和 / /）
• Roxygen文档（@tags）
• Markdown代码块
• 列表项目（- 和 *）

示例：

基本注释重排

之前：

# 这是一个非常长的注释，超出了自动换行列宽，需要重排以提高可读性和符合指定的宽度限制。

之后：

# 这是一个非常长的注释，超出了自动换行列宽，需要重排以提高可读性和
# 符合指定的宽度限制。

Roxygen文档重排

之前：

#' @param x 这是一个非常长的参数描述，超出了自动换行列宽，需要在保留Roxygen标签格式的同时进行重排。
#' @return 另一个长的描述，需要在保持适当文档结构的同时进行重排。

之后：

#' @param x 这是一个非常长的参数描述，超出了自动换行列宽，需要在保留
#'   Roxygen标签格式的同时进行重排。
#' 
#' @return 另一个长的描述，需要在保持适当文档结构的同时进行重排。

安装方法：

从VS Code市场安装（推荐）

1. 打开VS Code
2. 按Cmd Shift X（Mac）或Ctrl Shift X（Windows/Linux）打开扩展视图
3. 搜索"RStudio Comment Reflow"
4. 点击安装
5. 根据提示重载VS Code

手动安装

1. 从发布页面下载最新.vsix文件
2. 打开VS Code
3. 按Cmd Shift P（Mac）或Ctrl Shift P（Windows/Linux）打开命令面板
4. 输入“从VSIX安装”并选择命令
5. 导航到下载的.vsix文件并选择它
6. 然后使用Cmd Shift P或Ctrl Shift P输入“重载窗口”以重载VS Code

贡献：

欢迎贡献！请随时提交拉取请求。

许可证：

此扩展采用GNU Affero通用公共许可证第3版（AGPL-3.0）许可。这与RStudio使用的许可证相同，此扩展从中适配了代码。

完整的许可证文本可以在LICENSE文件中找到。额外的归属信息可在NOTICE文件中找到。

致谢：

此扩展适配了来自Posit RStudio的代码。注释重排功能基于RStudio的实现，部分代码版权归Posit Software, PBC（前RStudio）所有。

原始RStudio实现可在以下位置找到：

• 仓库：https://github.com/rstudio/rstudio/
• 许可证：AGPL v3