Dolphin模拟器项目代码规范与开发指南

Dolphin模拟器项目代码规范与开发指南

dolphin Dolphin is a GameCube / Wii emulator, allowing you to play games for these two platforms on PC with improvements. 项目地址: https://gitcode.com/gh_mirrors/do/dolphin

前言

Dolphin作为一款开源的GameCube和Wii模拟器，其代码质量直接关系到模拟器的性能和兼容性。本文将详细介绍Dolphin项目的代码规范要求，帮助开发者快速了解项目代码风格和最佳实践。

法律合规要求

商业机密保护

由于Dolphin涉及任天堂相关硬件模拟，项目特别重视法律合规性：

1. 禁止使用任何通过保密协议获得的商业机密信息
2. 禁止参考泄露的未公开技术文档
3. 严禁任何形式的盗版行为

代码授权

所有2014年12月1日后的代码贡献默认采用GPLv2+协议授权。

代码风格规范

基础格式要求

1. 行长度：建议不超过100字符，理想控制在80-90字符
2. 缩进：统一使用2个空格
3. 大括号：类、函数、条件语句等的大括号需换行
4. 指针/引用：类型与符号相连，如int* ptr

命名约定

• 类/枚举/函数：UpperCamelCase（如GameCubeController）
• 常量：全大写加下划线（如MAX_FRAME_RATE）
• 变量：小写加下划线（如frame_count）
• 特殊前缀：
  • 全局变量：g_
  • 成员变量：m_
  • 静态变量：s_

条件语句规范

// 正确示例
if (condition)
{
  // 代码块
}
else if (other_condition)
{
  // 代码块
}

// 单行语句可省略大括号
if (simple_check) return;

C++开发最佳实践

现代C++特性

1. 使用nullptr替代NULL
2. 优先使用范围for循环
3. 避免裸指针，多用智能指针和容器
4. 谨慎使用auto关键字

头文件管理

1. 包含顺序：
   • 当前源文件头文件
   • 标准库头文件
   • 系统特定头文件
   • 项目其他头文件
2. 使用#pragma once作为头文件保护

函数设计原则

1. 不修改的参数标记为const
2. 修改的参数使用指针明确标识
3. 禁止重写的函数使用final
4. 重写函数使用override标识

class VideoBackend final : public BackendInterface
{
public:
  void Render() override final;
  void SetConfig(const Config* config);
};

自动化工具链

clang-format集成

项目使用clang-format 19.1进行代码格式化，提供多种集成方式：

1. 手动格式化：

git diff --cached --name-only | grep -E '[.](cpp|h|mm)$' | xargs -I {} clang-format -i {}

2. Git预提交钩子：

ln -s ../../Tools/lint.sh .git/hooks/pre-commit

3. Visual Studio快捷键： Ctrl+K后接Ctrl+D自动格式化当前文档

Android开发规范

1. Kotlin代码使用官方标准风格
2. Java代码需导入项目提供的code-style-java.xml样式
3. 格式化快捷键：Ctrl+Alt+L

结语

遵循这些规范不仅能提高代码质量，还能加快代码审查和合并流程。Dolphin作为复杂的模拟器项目，统一的代码风格对维护至关重要。建议开发者在提交前使用自动化工具检查格式，并充分理解项目的设计理念和规范要求。

dolphin Dolphin is a GameCube / Wii emulator, allowing you to play games for these two platforms on PC with improvements. 项目地址: https://gitcode.com/gh_mirrors/do/dolphin