添加注释

src/Notes-master/app/src/main/java/net/micode/notes/tool/ResourceParser.java

@@ -22,24 +22,38 @@ import android.preference.PreferenceManager;
 import net.micode.notes.R;
 import net.micode.notes.ui.NotesPreferenceActivity;
 
+/**
+ * 资源解析工具类，负责管理和提供笔记应用中的各种资源ID
+ * 包括背景颜色、文本大小、不同界面元素的背景资源等
+ * 采用单例模式设计，通过静态方法提供全局访问
+ */
 public class ResourceParser {
 
+    // 定义笔记背景颜色常量
     public static final int YELLOW           = 0;
     public static final int BLUE             = 1;
     public static final int WHITE            = 2;
     public static final int GREEN            = 3;
     public static final int RED              = 4;
 
+    // 默认背景颜色为黄色
     public static final int BG_DEFAULT_COLOR = YELLOW;
 
+    // 定义文本大小常量
     public static final int TEXT_SMALL       = 0;
     public static final int TEXT_MEDIUM      = 1;
     public static final int TEXT_LARGE       = 2;
     public static final int TEXT_SUPER       = 3;
 
+    // 默认文本大小为中等
     public static final int BG_DEFAULT_FONT_SIZE = TEXT_MEDIUM;
 
+    /**
+     * 笔记编辑界面背景资源管理类
+     * 提供获取不同颜色背景资源ID的方法
+     */
     public static class NoteBgResources {
+        // 编辑界面主体背景资源数组，按颜色索引
         private final static int [] BG_EDIT_RESOURCES = new int [] {
             R.drawable.edit_yellow,
             R.drawable.edit_blue,
@@ -48,6 +62,7 @@ public class ResourceParser {
             R.drawable.edit_red
         };
 
+        // 编辑界面标题背景资源数组，按颜色索引
         private final static int [] BG_EDIT_TITLE_RESOURCES = new int [] {
             R.drawable.edit_title_yellow,
             R.drawable.edit_title_blue,
@@ -56,25 +71,48 @@ public class ResourceParser {
             R.drawable.edit_title_red
         };
 
+        /**
+         * 根据颜色ID获取编辑界面主体背景资源ID
+         * @param id 颜色ID，对应ResourceParser中定义的颜色常量
+         * @return 对应的背景资源ID
+         */
         public static int getNoteBgResource(int id) {
             return BG_EDIT_RESOURCES[id];
         }
 
+        /**
+         * 根据颜色ID获取编辑界面标题背景资源ID
+         * @param id 颜色ID，对应ResourceParser中定义的颜色常量
+         * @return 对应的标题背景资源ID
+         */
         public static int getNoteTitleBgResource(int id) {
             return BG_EDIT_TITLE_RESOURCES[id];
         }
     }
 
+    /**
+     * 获取默认背景颜色ID
+     * 根据用户偏好设置决定返回随机颜色还是默认黄色
+     * @param context 应用上下文
+     * @return 背景颜色ID
+     */
     public static int getDefaultBgId(Context context) {
         if (PreferenceManager.getDefaultSharedPreferences(context).getBoolean(
                 NotesPreferenceActivity.PREFERENCE_SET_BG_COLOR_KEY, false)) {
+            // 如果用户开启了随机背景选项，返回随机颜色ID
             return (int) (Math.random() * NoteBgResources.BG_EDIT_RESOURCES.length);
         } else {
+            // 默认返回黄色背景
             return BG_DEFAULT_COLOR;
         }
     }
 
+    /**
+     * 笔记列表项背景资源管理类
+     * 提供获取列表中不同位置笔记项背景资源ID的方法
+     */
     public static class NoteItemBgResources {
+        // 列表中第一项的背景资源数组，按颜色索引
         private final static int [] BG_FIRST_RESOURCES = new int [] {
             R.drawable.list_yellow_up,
             R.drawable.list_blue_up,
@@ -83,6 +121,7 @@ public class ResourceParser {
             R.drawable.list_red_up
         };
 
+        // 列表中中间项的背景资源数组，按颜色索引
         private final static int [] BG_NORMAL_RESOURCES = new int [] {
             R.drawable.list_yellow_middle,
             R.drawable.list_blue_middle,
@@ -91,6 +130,7 @@ public class ResourceParser {
             R.drawable.list_red_middle
         };
 
+        // 列表中最后一项的背景资源数组，按颜色索引
         private final static int [] BG_LAST_RESOURCES = new int [] {
             R.drawable.list_yellow_down,
             R.drawable.list_blue_down,
@@ -99,6 +139,7 @@ public class ResourceParser {
             R.drawable.list_red_down,
         };
 
+        // 列表中只有一项时的背景资源数组，按颜色索引
         private final static int [] BG_SINGLE_RESOURCES = new int [] {
             R.drawable.list_yellow_single,
             R.drawable.list_blue_single,
@@ -107,28 +148,57 @@ public class ResourceParser {
             R.drawable.list_red_single
         };
 
+        /**
+         * 获取列表中第一项的背景资源ID
+         * @param id 颜色ID
+         * @return 对应的背景资源ID
+         */
         public static int getNoteBgFirstRes(int id) {
             return BG_FIRST_RESOURCES[id];
         }
 
+        /**
+         * 获取列表中最后一项的背景资源ID
+         * @param id 颜色ID
+         * @return 对应的背景资源ID
+         */
         public static int getNoteBgLastRes(int id) {
             return BG_LAST_RESOURCES[id];
         }
 
+        /**
+         * 获取列表中只有一项时的背景资源ID
+         * @param id 颜色ID
+         * @return 对应的背景资源ID
+         */
         public static int getNoteBgSingleRes(int id) {
             return BG_SINGLE_RESOURCES[id];
         }
 
+        /**
+         * 获取列表中中间项的背景资源ID
+         * @param id 颜色ID
+         * @return 对应的背景资源ID
+         */
         public static int getNoteBgNormalRes(int id) {
             return BG_NORMAL_RESOURCES[id];
         }
 
+        /**
+         * 获取文件夹项的背景资源ID
+         * @return 文件夹背景资源ID
+         */
         public static int getFolderBgRes() {
             return R.drawable.list_folder;
         }
     }
 
+    /**
+     * 桌面小部件背景资源管理类
+     * 提供获取不同尺寸小部件背景资源ID的方法
+     */
     public static class WidgetBgResources {
+        // 2x尺寸小部件的背景资源数组，按颜色索引
         private final static int [] BG_2X_RESOURCES = new int [] {
             R.drawable.widget_2x_yellow,
             R.drawable.widget_2x_blue,
@@ -137,10 +207,16 @@ public class ResourceParser {
             R.drawable.widget_2x_red,
         };
 
+        /**
+         * 获取2x尺寸小部件的背景资源ID
+         * @param id 颜色ID
+         * @return 对应的背景资源ID
+         */
         public static int getWidget2xBgResource(int id) {
             return BG_2X_RESOURCES[id];
         }
 
+        // 4x尺寸小部件的背景资源数组，按颜色索引
         private final static int [] BG_4X_RESOURCES = new int [] {
             R.drawable.widget_4x_yellow,
             R.drawable.widget_4x_blue,
@@ -149,12 +225,22 @@ public class ResourceParser {
             R.drawable.widget_4x_red
         };
 
+        /**
+         * 获取4x尺寸小部件的背景资源ID
+         * @param id 颜色ID
+         * @return 对应的背景资源ID
+         */
         public static int getWidget4xBgResource(int id) {
             return BG_4X_RESOURCES[id];
         }
     }
 
+    /**
+     * 文本外观资源管理类
+     * 提供获取不同文本大小样式资源ID的方法
+     */
     public static class TextAppearanceResources {
+        // 文本外观样式资源数组，按大小索引
         private final static int [] TEXTAPPEARANCE_RESOURCES = new int [] {
             R.style.TextAppearanceNormal,
             R.style.TextAppearanceMedium,
@@ -162,11 +248,16 @@ public class ResourceParser {
             R.style.TextAppearanceSuper
         };
 
+        /**
+         * 根据ID获取文本外观样式资源ID
+         * 包含对无效ID的防御性编程处理
+         * @param id 文本大小ID，对应ResourceParser中定义的文本大小常量
+         * @return 对应的文本外观样式资源ID
+         */
         public static int getTexAppearanceResource(int id) {
             /**
-             * HACKME: Fix bug of store the resource id in shared preference.
+             * HACKME: 修复在共享偏好中存储资源ID可能导致的问题
-             * The id may larger than the length of resources, in this case,
+             * 如果ID大于资源数组长度，返回默认字体大小对应的资源ID
-             * return the {@link ResourceParser#BG_DEFAULT_FONT_SIZE}
              */
             if (id >= TEXTAPPEARANCE_RESOURCES.length) {
                 return BG_DEFAULT_FONT_SIZE;
@@ -174,6 +265,10 @@ public class ResourceParser {
             return TEXTAPPEARANCE_RESOURCES[id];
         }
 
+        /**
+         * 获取文本外观资源数组的长度
+         * @return 资源数组长度
+         */
         public static int getResourcesSize() {
             return TEXTAPPEARANCE_RESOURCES.length;
         }