From 3e0aee9c300d6404f90f2676ae6f8141b6b550b4 Mon Sep 17 00:00:00 2001 From: renjianbo <18691577328@163.com> Date: Thu, 15 Jan 2026 16:42:52 +0800 Subject: [PATCH] =?UTF-8?q?=E9=8F=87=E5=AD=98=E6=9F=8A=E9=8F=82=E5=9B=A8?= =?UTF-8?q?=E3=80=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../最佳实践/代码质量最佳实践.md | 1100 ++++++++++++++++- .../最佳实践/安全最佳实践.md | 866 ++++++++++++- 2 files changed, 1954 insertions(+), 12 deletions(-) diff --git a/docs/GoogleAndroid开发文档体系/最佳实践/代码质量最佳实践.md b/docs/GoogleAndroid开发文档体系/最佳实践/代码质量最佳实践.md index 510e058..b9acb68 100644 --- a/docs/GoogleAndroid开发文档体系/最佳实践/代码质量最佳实践.md +++ b/docs/GoogleAndroid开发文档体系/最佳实践/代码质量最佳实践.md @@ -1,9 +1,1097 @@ # 代码质量最佳实践 -## 待补充内容 +代码质量是Android应用开发的核心要素,直接影响应用的稳定性、可维护性和团队协作效率。本文档介绍Android开发中的代码质量最佳实践。 -- 代码规范 -- 代码审查 -- 代码重构 -- 代码测试 -- 文档编写 +## 目录 + +- [代码规范](#代码规范) +- [代码审查](#代码审查) +- [代码重构](#代码重构) +- [代码测试](#代码测试) +- [文档编写](#文档编写) + +--- + +## 代码规范 + +### 命名规范 + +#### 类命名 + +```java +// ✅ 好的命名:清晰、有意义、遵循Android约定 +public class MainActivity extends AppCompatActivity { } +public class UserRepository { } +public class LoginViewModel extends ViewModel { } +public class UserAdapter extends RecyclerView.Adapter { } + +// ❌ 不好的命名:模糊、无意义、不符合规范 +public class Activity1 { } +public class Manager { } +public class Repo { } +public class Adapter1 { } +``` + +**Android命名约定:** +- Activity:以`Activity`结尾,如`LoginActivity` +- Fragment:以`Fragment`结尾,如`UserListFragment` +- Service:以`Service`结尾,如`DownloadService` +- ViewModel:以`ViewModel`结尾,如`UserViewModel` +- Repository:以`Repository`结尾,如`UserRepository` +- Adapter:以`Adapter`结尾,如`UserAdapter` + +#### 方法命名 + +```java +// ✅ 好的命名:动词开头,清晰表达意图 +public void loadUserData() { } +public boolean isValidEmail(String email) { } +public User getUserById(String id) { } +public void showErrorMessage(String message) { } + +// ❌ 不好的命名:模糊、无意义 +public void load() { } +public boolean check(String str) { } +public User get(String id) { } +public void show(String msg) { } +``` + +#### 变量命名 + +```java +// ✅ 好的命名:清晰、有意义、遵循驼峰命名 +private String userName; +private int userCount; +private List userList; +private boolean isLoggedIn; +private static final String TAG = "MainActivity"; +private static final int REQUEST_CODE_LOGIN = 1001; + +// ❌ 不好的命名:缩写、无意义、不符合规范 +private String un; +private int uc; +private List ul; +private boolean logged; // 布尔值应使用is/has/can前缀 +``` + +#### 资源命名 + +```xml + + + +