Merge pull request 'from hjq' (#10) from hejiaqi_Branch into main

src/MiNotes-master/app/src/main/java/net/micode/notes/tool/GTaskStringUtils.java

@@ -14,8 +14,10 @@
  * limitations under the License.
  */
 
+//定义了很多的静态字符串，提供jsonObject中相应字符串的"key"。
 package net.micode.notes.tool;
  
+//这个类定义了jsonObject提供Key
 public class GTaskStringUtils { 
  
     public final static String GTASK_JSON_ACTION_ID = "action_id";

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

@@ -22,24 +22,45 @@ import android.preference.PreferenceManager;
 import net.micode.notes.R;
 import net.micode.notes.ui.NotesPreferenceActivity;
 
+/**
+ * ResourceParser类是一个工具类，用于解析应用程序中使用的资源。
+ */
 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;
 
+    /**
+     * NoteBgResources类包含与笔记编辑背景相关的资源。
+     */
     public static class NoteBgResources {
+        /**
+         * 笔记编辑背景资源数组
+         */
         private final static int [] BG_EDIT_RESOURCES = new int [] {
             R.drawable.edit_yellow,
             R.drawable.edit_blue,
@@ -48,6 +69,9 @@ 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,15 +80,30 @@ public class ResourceParser {
             R.drawable.edit_title_red
         };
 
+        /**
+         * 获取笔记编辑背景资源
+         * @param id 资源id
+         * @return 笔记编辑背景资源
+         */
         public static int getNoteBgResource(int id) {
             return BG_EDIT_RESOURCES[id];
         }
 
+        /**
+         * 获取笔记编辑标题背景资源
+         * @param id 资源id
+         * @return 笔记编辑标题背景资源
+         */
         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)) {
@@ -74,7 +113,13 @@ public class ResourceParser {
         }
     }
 
+    /**
+     * NoteItemBgResources类包含与笔记列表项背景相关的资源。
+     */
     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 +128,9 @@ 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 +139,9 @@ 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 +150,9 @@ 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 +161,58 @@ public class ResourceParser {
             R.drawable.list_red_single
         };
 
+        /**
+         * 获取第一项背景资源
+         * @param id 资源id
+         * @return 第一项背景资源
+         */
         public static int getNoteBgFirstRes(int id) {
             return BG_FIRST_RESOURCES[id];
         }
 
+        /**
+         * 获取最后一项背景资源
+         * @param id 资源id
+         * @return 最后一项背景资源
+         */
         public static int getNoteBgLastRes(int id) {
             return BG_LAST_RESOURCES[id];
         }
 
+        /**
+         * 获取单项背景资源
+         * @param id 资源id
+         * @return 单项背景资源
+         */
         public static int getNoteBgSingleRes(int id) {
             return BG_SINGLE_RESOURCES[id];
         }
 
+        /**
+         * 获取普通项背景资源
+         * @param id 资源id
+         * @return 普通项背景资源
+         */
         public static int getNoteBgNormalRes(int id) {
             return BG_NORMAL_RESOURCES[id];
         }
 
+        /**
+         * 获取文件夹背景资源
+         * @return 文件夹背景资源
+         */
         public static int getFolderBgRes() {
             return R.drawable.list_folder;
         }
     }
 
+    /**
+     * WidgetBgResources类包含与小部件背景相关的资源。
+     */
     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 +221,18 @@ public class ResourceParser {
             R.drawable.widget_2x_red,
         };
 
+        /**
+         * 获取2x小部件背景资源
+         * @param id 资源id
+         * @return 2x小部件背景资源
+         */
         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 +241,23 @@ public class ResourceParser {
             R.drawable.widget_4x_red
         };
 
+        /**
+         * 获取4x小部件背景资源
+         * @param id 资源id
+         * @return 4x小部件背景资源
+         */
         public static int getWidget4xBgResource(int id) {
             return BG_4X_RESOURCES[id];
         }
     }
 
+    /**
+     * TextAppearanceResources类包含与文本外观相关的资源。
+     */
     public static class TextAppearanceResources {
+        /**
+         * 文本外观资源数组
+         */
         private final static int [] TEXTAPPEARANCE_RESOURCES = new int [] {
             R.style.TextAppearanceNormal,
             R.style.TextAppearanceMedium,
@@ -162,11 +265,15 @@ public class ResourceParser {
             R.style.TextAppearanceSuper
         };
 
+        /**
+         * 获取文本外观资源
+         * @param id 资源id
+         * @return 文本外观资源
+         */
         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可能大于资源数组的长度，在这种情况下，返回BG_DEFAULT_FONT_SIZE。
-             * return the {@link ResourceParser#BG_DEFAULT_FONT_SIZE}
              */
             if (id >= TEXTAPPEARANCE_RESOURCES.length) {
                 return BG_DEFAULT_FONT_SIZE;
@@ -174,6 +281,10 @@ public class ResourceParser {
             return TEXTAPPEARANCE_RESOURCES[id];
         }
 
+        /**
+         * 获取资源的大小
+         * @return 资源的大小
+         */
         public static int getResourcesSize() {
             return TEXTAPPEARANCE_RESOURCES.length;
         }