Android开发规范

一、编码风格与格式

1. 命名规范：

   • 变量名、方法名、类名等应遵循Java的命名约定。局部变量和参数使用小驼峰命名法（lowerCamelCase）

     如：int myVariable。

   • 类名使用大驼峰命名法（UpperCamelCase），也称为Pascal命名法，

     如：public class MyClass。

   • 常量名应全部大写，并使用下划线分隔单词

     如：public static final int MAX_VALUE = 100;。

   • 对于资源ID，如layout中的id，应遵循一定的命名模式

     如：view缩写_模块名称_view的逻辑名称，例如：btn_login_submit。

2. 代码格式：

   • 使用统一的缩进和空格规则。通常，每个缩进级别使用4个空格。
   • 避免一行代码过长，建议每行不超过80个字符。
   • 使用空行来提高代码的可读性。例如，在方法之间、逻辑段之间等使用空行。
   • 注释应清晰明了，说明代码的功能、参数、返回值以及可能的异常情况。

3. 书写规范：

   • 编码方式统一使用UTF-8。
   • 花括号不要单独一行，应和前面的代码或语句在同一行，并用一个空格隔开。
   • 对于逻辑关键字（如if、else、for等）和运算符，与后面的语句或操作数之间应留一个空格。
   • 尽量避免一行声明多个变量，以提高代码的可读性。

4. 异常处理

   • 所有 cache 处理，不允许直接使用 printStackTrace() 打印异常，只能使用日志管理工具 Log.e("TAG", "XXX") 方式打印异常（或自定义日志管理工具输出异常信息）

二、资源文件管理

1. 资源目录结构：
   • res目录下应包含与界面和用户界面相关的所有文件。其中，drawable用于存放图片资源，layout用于存放布局文件，values用于存放各种资源的配置文件（如strings.xml）。
   • 图片资源文件应采用全小写的下划线命名法，如ic_launcher.png。
   • 值资源文件（如strings.xml）中的id命名也应采用全小写的下划线命名法。
2. 资源引用：
   • 在代码中引用资源时，应使用R类中的静态常量，而不是直接引用资源文件的ID。
   • 避免使用硬编码的资源引用，而应使用@string/my_string、@drawable/my_image等形式。
     创建人：puwb

     修改人：puwb

快速跳转

• Android开发规范
  • 一、编码风格与格式
  • 二、资源文件管理