RoslynPad 技术文档

RoslynPad 技术文档

roslynpad 项目地址: https://gitcode.com/gh_mirrors/ros/roslynpad

RoslynPad 是一个基于 Roslyn 编译器和 AvalonEdit 的跨平台 C# 编辑器，提供了丰富的代码编辑特性，如自动完成、签名帮助、诊断以及代码修复等。本文档旨在指导您从安装到使用的每一个步骤，确保您能够充分利用 RoslynPad。

安装指南

对于 Windows 用户：

1. 通过GitHub下载: 访问 最新版本页面，下载适用于您的系统版本的安装包。
2. 微软商店: 直接在微软商店搜索“RoslynPad”并安装。
3. 使用winget命令行工具: 在命令提示符或PowerShell中输入 winget install --id RoslynPad.RoslynPad 来安装。

对于macOS用户:

1. 下载最新的.dmg文件从GitHub发布页。
2. 将应用拖放到“应用程序”目录。
3. 首次运行时，在Finder中右键点击应用，并选择“打开”。如果您遇到开发者未被识别的警告，按照提示操作并选择“打开”。

.NET SDK要求:

确保您的系统上已安装了支持的.NET SDK。RoslynPad需要.NET SDK来编译程序。

项目的使用说明

启动RoslynPad后，您可以立即开始编写C#代码。界面简洁直观，拥有以下核心功能：

• 编写代码: 直接在编辑区域输入C#代码。
• 编译与执行: RoslynPad会实时分析代码，提供即时反馈。
• 利用快捷键: 按照标准IDE的习惯配置快捷键进行代码导航和操作。

项目API使用文档

对于希望将RoslynPad的编辑能力和服务集成进自己应用的开发者：

1. RoslynPad.Roslyn: 提供内部的Roslyn服务接口，允许您接入其强大的编译和分析能力。
2. RoslynPad.Roslyn.Windows / RoslynPad.Roslyn.Avalonia: 分别为WPF和Avalonia平台提供UI组件实现，适配不同的GUI需求。
3. 编辑器包: 如 RoslynPad.Editor.Windows 和 RoslynPad.Editor.Avalonia 提供现成的代码编辑器控制，内置完成、诊断和快速操作等功能。

每个NuGet包都有详细的版本号，对应相应的Roslyn版本，确保兼容性。

项目构建

开发者若想从源码构建RoslynPad:

• 使用 dotnet build 命令。
• 或者，在Visual Studio 2022中打开解决方案。
• 同样，Visual Studio Code配合C#插件也是个不错的选择。

有两个主要的解决方案文件可供选择：

• src/RoslynPad.sln: 包含所有项目（推荐Windows环境下使用）。
• src/RoslynPad.Avalonia.sln: 只包含跨平台相关项目。

---

本文档以Markdown格式提供，详细解析了RoslynPad的安装、基本使用流程以及如何利用其提供的API。遵循这些指南，无论是作为日常的代码编辑工具还是作为开发新应用的技术栈部分，RoslynPad都能为您提供高效的支持。

roslynpad 项目地址: https://gitcode.com/gh_mirrors/ros/roslynpad