notes注释

src/net/micode/notes/data/Notes.java

@@ -18,11 +18,30 @@ package net.micode.notes.data;
 
 import android.net.Uri;
 public class Notes {
+        /**
+     * 内容提供者的 Authority，用于唯一标识 ContentProvider。
+     */
     public static final String AUTHORITY = "micode_notes";
+
+    /**
+     * 默认 TAG，用于日志输出。
+     */
     public static final String TAG = "Notes";
-    public static final int TYPE_NOTE     = 0;
+
-    public static final int TYPE_FOLDER   = 1;
+    /**
-    public static final int TYPE_SYSTEM   = 2;
+     * 笔记类型：普通笔记。
+     */
+    public static final int TYPE_NOTE = 0;
+
+    /**
+     * 笔记类型：文件夹。
+     */
+    public static final int TYPE_FOLDER = 1;
+
+    /**
+     * 笔记类型：系统文件夹。
+     */
+    public static final int TYPE_SYSTEM = 2;
 
     /**
      * Following IDs are system folders' identifiers
@@ -30,41 +49,104 @@ public class Notes {
      * {@link Notes#ID_TEMPARAY_FOLDER } is for notes belonging no folder
      * {@link Notes#ID_CALL_RECORD_FOLDER} is to store call records
      */
+    /**
+     * 根文件夹 ID，默认主界面显示的文件夹。
+     */
     public static final int ID_ROOT_FOLDER = 0;
+
+    /**
+     * 临时文件夹 ID，存放不属于任何文件夹的笔记。
+     */
     public static final int ID_TEMPARAY_FOLDER = -1;
+
+    /**
+     * 来电记录文件夹 ID，存储通话记录笔记。
+     */
     public static final int ID_CALL_RECORD_FOLDER = -2;
+
+    /**
+     * 回收站文件夹 ID，存放已删除的笔记。
+     */
     public static final int ID_TRASH_FOLER = -3;
 
+        /**
+     * Intent Extra 键值：提醒日期。
+     */
     public static final String INTENT_EXTRA_ALERT_DATE = "net.micode.notes.alert_date";
+
+    /**
+     * Intent Extra 键值：背景颜色 ID。
+     */
     public static final String INTENT_EXTRA_BACKGROUND_ID = "net.micode.notes.background_color_id";
+
+    /**
+     * Intent Extra 键值：小部件 ID。
+     */
     public static final String INTENT_EXTRA_WIDGET_ID = "net.micode.notes.widget_id";
+
+    /**
+     * Intent Extra 键值：小部件类型。
+     */
     public static final String INTENT_EXTRA_WIDGET_TYPE = "net.micode.notes.widget_type";
+
+    /**
+     * Intent Extra 键值：文件夹 ID。
+     */
     public static final String INTENT_EXTRA_FOLDER_ID = "net.micode.notes.folder_id";
+
+    /**
+     * Intent Extra 键值：来电时间。
+     */
     public static final String INTENT_EXTRA_CALL_DATE = "net.micode.notes.call_date";
 
-    public static final int TYPE_WIDGET_INVALIDE      = -1;
+      /**
-    public static final int TYPE_WIDGET_2X            = 0;
+     * 无效的小部件类型。
-    public static final int TYPE_WIDGET_4X            = 1;
+     */
+    public static final int TYPE_WIDGET_INVALIDE = -1;
+
+    /**
+     * 2x 尺寸的小部件类型。
+     */
+    public static final int TYPE_WIDGET_2X = 0;
 
+    /**
+     * 4x 尺寸的小部件类型。
+     */
+    public static final int TYPE_WIDGET_4X = 1;
+
+
+       /**
+     * 数据 MIME 类型常量定义。
+     */
     public static class DataConstants {
+        /**
+         * 文本笔记的 MIME 类型。
+         */
         public static final String NOTE = TextNote.CONTENT_ITEM_TYPE;
+
+        /**
+         * 来电记录笔记的 MIME 类型。
+         */
         public static final String CALL_NOTE = CallNote.CONTENT_ITEM_TYPE;
     }
 
-    /**
+
-     * Uri to query all notes and folders
+
+     /**
+     * 查询所有笔记和文件夹的 Uri。
      */
     public static final Uri CONTENT_NOTE_URI = Uri.parse("content://" + AUTHORITY + "/note");
 
     /**
-     * Uri to query data
+     * 查询数据的 Uri。
      */
     public static final Uri CONTENT_DATA_URI = Uri.parse("content://" + AUTHORITY + "/data");
 
+    
     public interface NoteColumns {
-        /**
+         /**
-         * The unique ID for a row
+         * 行的唯一 ID。
-         * <P> Type: INTEGER (long) </P>
+         * <P>类型: INTEGER (long)</P>
          */
         public static final String ID = "_id";
 
@@ -169,8 +251,8 @@ public class Notes {
 
     public interface DataColumns {
         /**
-         * The unique ID for a row
+         * 行的唯一 ID。
-         * <P> Type: INTEGER (long) </P>
+         * <P>类型: INTEGER (long)</P>
          */
         public static final String ID = "_id";
 
@@ -240,40 +322,68 @@ public class Notes {
          */
         public static final String DATA5 = "data5";
     }
-
+    /**
+     * 文本笔记的数据结构定义。
+     * 实现了 DataColumns 接口，表示文本笔记的数据字段。
+     */
     public static final class TextNote implements DataColumns {
         /**
-         * Mode to indicate the text in check list mode or not
+         * 模式字段，用于区分普通模式和检查清单模式。
-         * <P> Type: Integer 1:check list mode 0: normal mode </P>
+         * <P>类型: Integer 1:检查清单模式 0:普通模式</P>
          */
-        public static final String MODE = DATA1;
+       public static final String MODE = DATA1;
 
+        /**
+         * 检查清单模式的值。
+         */
         public static final int MODE_CHECK_LIST = 1;
 
+        /**
+         * 多个文本笔记的 MIME 类型。
+         */
         public static final String CONTENT_TYPE = "vnd.android.cursor.dir/text_note";
 
+        /**
+         * 单个文本笔记的 MIME 类型。
+         */
         public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/text_note";
 
+        /**
+         * 查询文本笔记的 Uri。
+         */
         public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/text_note");
     }
 
+     /**
+     * 来电记录笔记的数据结构定义。
+     * 实现了 DataColumns 接口，表示来电记录笔记的数据字段。
+     */
     public static final class CallNote implements DataColumns {
         /**
-         * Call date for this record
+         * 来电时间字段。
-         * <P> Type: INTEGER (long) </P>
+         * <P>类型: INTEGER (long)</P>
          */
         public static final String CALL_DATE = DATA1;
 
         /**
-         * Phone number for this record
+         * 电话号码字段。
-         * <P> Type: TEXT </P>
+         * <P>类型: TEXT</P>
          */
         public static final String PHONE_NUMBER = DATA3;
 
+        /**
+         * 多个来电记录笔记的 MIME 类型。
+         */
         public static final String CONTENT_TYPE = "vnd.android.cursor.dir/call_note";
 
+        /**
+         * 单个来电记录笔记的 MIME 类型。
+         */
         public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/call_note";
 
+        /**
+         * 查询来电记录笔记的 Uri。
+         */
         public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/call_note");
     }
 }