AndroidRemoteController/doc/代码规范.md

编码规范

1. 变量名、文件名、文件夹名要有意义。超过十个字符的单词使用缩写。缩写必须超过三个字符。

• ✅ update-btn (刷新按钮), device-list, user-profile-settings (profile = 缩写)
• ❌ btn (太模糊), d1 (无意义), temp (不清楚), us (缩写太短)

2. 多词名称使用连字符 (-)。

3. 注释：一个函数，一个注释

4. 使用函数来分离不同的逻辑。避免在单个函数中编写过多逻辑。

5. 永远不要使用 try-catch。让错误崩溃。

6. GUI 组件必须拆分为三个文件：

• .jsx: 仅布局（无逻辑，无样式）
• .js: 仅逻辑（函数、状态、业务逻辑）
• .scss: 仅样式（无逻辑，无 JSX）

永远不要在 .jsx 文件中编写逻辑或内联样式。

7. 使用最少的代码来实现功能。

8. 不要在生产代码中添加任何 console.log 语句。

9. 不要不必要地创建脚本文件。如果可以直接调用 PowerShell，使用 PowerShell 而不是创建单独的脚本文件。

10. 如果需要创建任何新文件，必须先询问。

11. 当检查同一变量与多个值进行比较时，使用 switch 语句而不是多个 if-else 链。

12. 优先使用提前返回而不是 else 块

优先使用提前返回模式：

if (condition) { 
    ...
    return;
}

而不是：

if (condition) {
    ...
} else {
    ...
}

13. 不进行存在性检查

不要添加 if 语句来检查目录是否存在、文件是否存在或解析是否成功。让错误崩溃。

14. 所有传进来的参数都不要验证，要假设所有参数已经经过验证没有问题。