附录 D - 有用的开发工具
在本附录中，我们将讨论 X 语言官方项目提供的一些有用的开发工具，以及它们如何帮助你编写 X 语言代码。
自动格式化与 x fmt
x fmt 工具根据标准样式格式化你的代码。无论你喜欢什么样式，许多项目都选择使用 x fmt 来结束关于样式的争论：每个人都使用 X 语言官方工具格式化他们的代码。
要格式化任何 X 语言项目，请运行：
x fmt
此工具将以标准 X 语言样式重新格式化所有代码。许多程序员将 x fmt 作为其工作流程的一部分，以保持代码整洁。
修复代码与 x fix
x fix 工具会自动修复代码中的某些问题。
自动修复警告
如果你有一个会产生警告的代码，x fix 可能能够自动修复它：
x fix
版本过渡
x fix 还可以帮助你的代码过渡到新版本的 X 语言：
x fix --edition
代码分析与 x check
x check 工具快速检查你的代码是否有错误。
x check
这比完整的编译更快，并且对于快速检查错误很有用。
语言服务器与 LSP 支持
X 语言对 LSP（语言服务器协议）有支持，以支持 IDE 集成。
设置 LSP
许多 IDE 和编辑器支持 LSP。要使用 X 语言 LSP：
- 安装 LSP 服务器 - 如果单独提供的话，安装 X 语言 LSP 服务器
- 配置编辑器 - 配置你的编辑器使用它
- 享受！ - 享受自动完成、跳转定义等功能
LSP 功能
X 语言 LSP 提供：
- 自动完成 - 代码的建议补全
- 跳转定义 - 跳转到定义某物的地方
- 查找引用 - 查找某物在何处使用
- 悬停信息 - 悬停时显示信息
- 实时诊断 - 实时显示错误和警告
- 重命名 - 安全地重命名事物
- 格式化 - 使用
x fmt格式化
调试支持
X 语言支持使用标准调试器进行调试。
GDB/LLDB
你可以使用 GDB 或 LLDB 调试 X 语言程序：
# 使用调试信息构建
x build --debug
# 使用 GDB 调试
gdb ./target/debug/my_program
# 或者使用 LLDB
lldb ./target/debug/my_program
IDE 集成
大多数 IDE 也内置了对调试的支持。
性能分析
基准测试
你可以使用内置的基准测试支持对代码进行基准测试：
benchmark my_benchmark {
// 你要测量的代码
}
然后运行：
x bench
性能分析工具
X 语言程序可以使用标准性能分析工具进行性能分析：
- perf - 在 Linux 上
- Instruments - 在 macOS 上
- VTune - 在 Windows 上
文档生成
x doc
x doc 工具为你的代码生成 HTML 文档：
x doc --open
这将生成文档并在 Web 浏览器中打开它。
文档注释
使用文档注释记录你的代码：
/// 将给定的数字加一。
///
/// # 示例
///
/// ```
/// let five = 5;
/// assert_eq!(6, add_one(five));
/// ```
function add_one(x: integer) -> integer {
x + 1
}
其他有用的工具
x clippy（如果可用）
如果可用，x clippy 是一个提供额外警告和建议的 lint 工具。
x test
我们已经讨论了测试，但提醒一下，x test 运行你的测试：
x test
x expand（如果可用）
x expand 展开宏以查看它们生成什么代码。
IDE 支持
流行的 IDE
X 语言支持多种 IDE：
- VS Code - 带有 X 语言扩展
- IntelliJ IDEA - 带有 X 语言插件
- Vim/Neovim - 带有 X 语言支持
- Emacs - 带有 X 语言模式
- Sublime Text - 带有 X 语言包
功能
大多数现代 X 语言 IDE 支持：
- 语法高亮
- 自动完成
- 跳转定义
- 查找引用
- 内联错误
- 重构工具
- 调试支持
- 集成测试运行器
总结
有用的 X 语言开发工具：
- x fmt - 自动格式化你的代码
- x fix - 自动修复某些问题
- x check - 快速检查错误
- LSP 支持 - IDE 集成
- 调试器 - GDB、LLDB 和 IDE 支持
- x bench - 基准测试
- x doc - 文档生成
- IDE - VS Code、IntelliJ、Vim 等
这些工具使编写 X 语言代码变得更加容易和愉快！