OmniSharp-vim 项目使用教程

OmniSharp-vim 项目使用教程

omnisharp-vim Vim omnicompletion (intellisense) and more for C# 项目地址: https://gitcode.com/gh_mirrors/om/omnisharp-vim

1. 项目目录结构及介绍

OmniSharp-vim 是一个为 Vim 编辑器提供 C# 语言 IDE 功能的插件。项目的目录结构如下：

• .github/：存放 GitHub Actions 的工作流文件。
• autoload/：包含 Vim 自动加载的脚本。
• doc/：存放项目文档。
• ftdetect/：包含文件类型检测脚本。
• ftplugin/：包含针对 C# 文件类型的功能插件脚本。
• installer/：存放安装脚本。
• log/：日志文件存放目录。
• plugin/：包含主插件脚本。
• python/：存放 Python 代码（如果需要）。
• python3/：存放 Python 3 代码。
• rplugin/：用于 Vim 的 Ruby 插件代码。
• syntax/：语法高亮定义文件。
• syntax_checkers/：代码检查器相关文件。
• test/：测试文件存放目录。
• .gitattributes：定义 Git 的一些行为。
• .gitignore：定义 Git 忽略的文件。
• .gitmodules：定义子模块信息。
• LICENSE.md：项目许可证信息。
• README.md：项目说明文件。

2. 项目的启动文件介绍

OmniSharp-vim 插件依赖于 OmniSharp-Roslyn 服务器。在第一次打开 C# 文件时，插件会检查服务器的存在性。如果服务器不存在，插件会提示用户下载。用户同意后，最新版本的 OmniSharp-Roslyn 将被下载并解压到 ~/.cache/omnisharp-vim/omnisharp-roslyn 目录。

项目的启动主要是通过 Vim 插件管理器安装插件，然后在 Vim 中打开 C# 文件，这时插件会自动与 OmniSharp-Roslyn 服务器进行通信。

3. 项目的配置文件介绍

OmniSharp-vim 插件的配置主要通过 .vimrc 文件进行。以下是一些常用的配置项：

• g:OmniSharp_server_stdio：决定使用 stdio 服务器还是 HTTP 服务器。默认为 1，使用 stdio 服务器。
• g:OmniSharp_server_path：指定 OmniSharp-Roslyn 服务器的路径。
• g:OmniSharp_server_use_mono：决定是否使用已安装的 mono 运行服务器。
• g:OmniSharp_server_use_net6：从版本 1.38.0 开始，可以选择使用 net6.0 的原生服务器。

用户需要根据自己的环境和需求来配置这些变量。配置完成后，可以使用 :OmniSharpInstall 命令来安装或更新 OmniSharp-Roslyn 服务器。如果需要安装特定版本的 OmniSharp-Roslyn，可以在命令中指定版本号，如 :OmniSharpInstall v1.35.2。

omnisharp-vim Vim omnicompletion (intellisense) and more for C# 项目地址: https://gitcode.com/gh_mirrors/om/omnisharp-vim