信亚杰 data包注释

src/Notes-master/src/net/micode/notes/data/Contact.java

@@ -25,47 +25,67 @@ import android.util.Log;
 
 import java.util.HashMap;
 
+// 该类用于获取与给定电话号码对应的联系人姓名，通过缓存已查询结果来提高性能
+
 public class Contact {
+    // 该类用于获取与给定电话号码对应的联系人姓名，通过缓存已查询结果来提高性能
     private static HashMap<String, String> sContactCache;
+    // 日志标签，用于在 Log 输出中标识该类的相关信息
     private static final String TAG = "Contact";
-
+    // 查询条件字符串，用于从联系人数据库中筛选出匹配电话号码的记录
+    // 它通过比较电话号码和联系人数据中的电话号码，确保数据类型为电话类型，并限制在特定的 raw_contact_id 范围内进行查询
+    // 其中，PHONE_NUMBERS_EQUAL 是一个函数，用于比较电话号码是否相等，这里使用了占位符 '?'，后续会替换为实际的电话号码
+    // Data.MIMETYPE 用于指定数据类型，Phone.CONTENT_ITEM_TYPE 表示电话类型的数据
+    // Data.RAW_CONTACT_ID 用于指定原始联系人 ID，这里通过子查询从 phone_lookup 表中获取满足 min_match = '+' 条件的 raw_contact_id
     private static final String CALLER_ID_SELECTION = "PHONE_NUMBERS_EQUAL(" + Phone.NUMBER
     + ",?) AND " + Data.MIMETYPE + "='" + Phone.CONTENT_ITEM_TYPE + "'"
     + " AND " + Data.RAW_CONTACT_ID + " IN "
             + "(SELECT raw_contact_id "
             + " FROM phone_lookup"
             + " WHERE min_match = '+')";
-
+     // 根据给定的上下文和电话号码获取联系人姓名的静态方法
     public static String getContact(Context context, String phoneNumber) {
+         // 如果缓存为空，则创建一个新的 HashMap 用于缓存
         if(sContactCache == null) {
             sContactCache = new HashMap<String, String>();
         }
-
+        // 首先检查缓存中是否已经存在该电话号码对应的联系人姓名，如果存在则直接返回缓存中的结果
         if(sContactCache.containsKey(phoneNumber)) {
             return sContactCache.get(phoneNumber);
         }
-
+        // 替换查询条件中的 '+' 为电话号码的最小匹配格式，以便进行更准确的查询
         String selection = CALLER_ID_SELECTION.replace("+",
                 PhoneNumberUtils.toCallerIDMinMatch(phoneNumber));
+         // 使用 ContentResolver 查询联系人数据库，获取匹配电话号码的联系人姓名
+        // 查询的 URI 为 Data.CONTENT_URI，表示联系人数据的通用 URI
+        // 查询的列仅包含 Phone.DISPLAY_NAME，即联系人的显示名称
+        // 选择条件为上面生成的 selection，选择参数为实际的电话号码
+        // 排序方式为默认，这里传入 null        
         Cursor cursor = context.getContentResolver().query(
                 Data.CONTENT_URI,
                 new String [] { Phone.DISPLAY_NAME },
                 selection,
                 new String[] { phoneNumber },
                 null);
-
+        // 如果查询结果不为空且游标能够移动到第一条记录，则表示找到了匹配的联系人
         if (cursor != null && cursor.moveToFirst()) {
             try {
+                // 从游标中获取联系人姓名，索引为 0，因为查询结果只包含一列联系人姓名
                 String name = cursor.getString(0);
+                // 将查询到的电话号码和对应的联系人姓名存入缓存
                 sContactCache.put(phoneNumber, name);
+                // 返回联系人姓名
                 return name;
             } catch (IndexOutOfBoundsException e) {
+                 // 如果在获取游标数据时发生越界异常，则记录错误日志，并返回 null
                 Log.e(TAG, " Cursor get string error " + e.toString());
                 return null;
             } finally {
+                 // 无论是否发生异常，都需要关闭游标，释放资源
                 cursor.close();
             }
         } else {
+            // 如果没有找到匹配的联系人，则记录调试日志，并返回 null
             Log.d(TAG, "No contact matched with number:" + phoneNumber);
             return null;
         }

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

@@ -17,12 +17,20 @@
 package net.micode.notes.data;
 
 import android.net.Uri;
+
+// 该类用于定义笔记应用程序中的各种常量和数据结构相关信息
 public class Notes {
+     // 定义笔记应用的授权（Authority），用于 Content Provider 的标识
     public static final String AUTHORITY = "micode_notes";
+    // 日志标签，用于在应用中标记与笔记相关的日志信息
     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;
+    // 系统文件夹的标识符
+    // ID_ROOT_FOLDER 是默认文件夹的 ID
 
     /**
      * Following IDs are system folders' identifiers
@@ -31,179 +39,194 @@ public class Notes {
      * {@link Notes#ID_CALL_RECORD_FOLDER} is to store call records
      */
     public static final int ID_ROOT_FOLDER = 0;
+    // ID_TEMPARAY_FOLDER 用于存放不属于任何文件夹的笔记
     public static final int ID_TEMPARAY_FOLDER = -1;
+    // ID_CALL_RECORD_FOLDER 用于存储通话记录的文件夹 ID
     public static final int ID_CALL_RECORD_FOLDER = -2;
+    // ID_TRASH_FOLER 垃圾桶文件夹 ID
     public static final int ID_TRASH_FOLER = -3;
+    // 用于传递提醒日期的 Intent 额外数据键
 
     public static final String INTENT_EXTRA_ALERT_DATE = "net.micode.notes.alert_date";
+    // 用于传递背景颜色 ID 的 Intent 额外数据键
     public static final String INTENT_EXTRA_BACKGROUND_ID = "net.micode.notes.background_color_id";
+    // 用于传递小部件 ID 的 Intent 额外数据键
     public static final String INTENT_EXTRA_WIDGET_ID = "net.micode.notes.widget_id";
+    // 用于传递小部件类型的 Intent 额外数据键
     public static final String INTENT_EXTRA_WIDGET_TYPE = "net.micode.notes.widget_type";
+    // 用于传递文件夹 ID 的 Intent 额外数据键
     public static final String INTENT_EXTRA_FOLDER_ID = "net.micode.notes.folder_id";
+    // 用于传递通话日期的 Intent 额外数据键
     public static final String INTENT_EXTRA_CALL_DATE = "net.micode.notes.call_date";
-
+     // 无效的小部件类型
     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;
-
+    // 内部类，用于定义数据常量
     public static class DataConstants {
+        // 文本笔记的 Content Item Type
         public static final String NOTE = TextNote.CONTENT_ITEM_TYPE;
+        // 通话笔记的 Content Item Type
         public static final String CALL_NOTE = CallNote.CONTENT_ITEM_TYPE;
     }
-
+    // 用于查询所有笔记和文件夹的 Uri
     /**
      * Uri to query all notes and folders
      */
     public static final Uri CONTENT_NOTE_URI = Uri.parse("content://" + AUTHORITY + "/note");
-
+    // 用于查询数据的 Uri
     /**
      * Uri to query data
      */
     public static final Uri CONTENT_DATA_URI = Uri.parse("content://" + AUTHORITY + "/data");
-
+    // 定义笔记列的接口
     public interface NoteColumns {
+        // 行的唯一 ID，类型为长整型整数
         /**
          * The unique ID for a row
          * <P> Type: INTEGER (long) </P>
          */
         public static final String ID = "_id";
-
+        // 笔记或文件夹的父 ID，类型为长整型整数    
         /**
          * The parent's id for note or folder
          * <P> Type: INTEGER (long) </P>
          */
         public static final String PARENT_ID = "parent_id";
-
+        // 笔记或文件夹的创建日期，类型为长整型整数
         /**
          * Created data for note or folder
          * <P> Type: INTEGER (long) </P>
          */
         public static final String CREATED_DATE = "created_date";
-
+        // 最新修改日期，类型为长整型整数
         /**
          * Latest modified date
          * <P> Type: INTEGER (long) </P>
          */
         public static final String MODIFIED_DATE = "modified_date";
-
+        // 提醒日期，类型为长整型整数
 
         /**
          * Alert date
          * <P> Type: INTEGER (long) </P>
          */
         public static final String ALERTED_DATE = "alert_date";
-
+        // 文件夹名称或笔记的文本内容，类型为文本
         /**
          * Folder's name or text content of note
          * <P> Type: TEXT </P>
          */
         public static final String SNIPPET = "snippet";
-
+        // 笔记的小部件 ID，类型为长整型整数
         /**
          * Note's widget id
          * <P> Type: INTEGER (long) </P>
          */
         public static final String WIDGET_ID = "widget_id";
-
+        // 笔记的小部件类型，类型为长整型整数
         /**
          * Note's widget type
          * <P> Type: INTEGER (long) </P>
          */
         public static final String WIDGET_TYPE = "widget_type";
-
+        // 笔记的背景颜色 ID，类型为长整型整数
         /**
          * Note's background color's id
          * <P> Type: INTEGER (long) </P>
          */
         public static final String BG_COLOR_ID = "bg_color_id";
-
+        // 对于文本笔记，无附件时为 0，多媒体笔记至少有一个附件时为 1，类型为整数
         /**
          * For text note, it doesn't has attachment, for multi-media
          * note, it has at least one attachment
          * <P> Type: INTEGER </P>
          */
         public static final String HAS_ATTACHMENT = "has_attachment";
-
+         // 文件夹中的笔记数量，类型为长整型整数
         /**
          * Folder's count of notes
          * <P> Type: INTEGER (long) </P>
          */
         public static final String NOTES_COUNT = "notes_count";
-
+         // 文件类型（文件夹或笔记），类型为整数
         /**
          * The file type: folder or note
          * <P> Type: INTEGER </P>
          */
         public static final String TYPE = "type";
-
+        // 最后同步 ID，类型为长整型整数
         /**
          * The last sync id
          * <P> Type: INTEGER (long) </P>
          */
         public static final String SYNC_ID = "sync_id";
-
+        // 表示本地是否修改的标志，类型为整数
         /**
          * Sign to indicate local modified or not
          * <P> Type: INTEGER </P>
          */
         public static final String LOCAL_MODIFIED = "local_modified";
-
+        // 移动到临时文件夹之前的原始父 ID，类型为整数
         /**
          * Original parent id before moving into temporary folder
          * <P> Type : INTEGER </P>
          */
         public static final String ORIGIN_PARENT_ID = "origin_parent_id";
-
+        // gtask ID，类型为文本
         /**
          * The gtask id
          * <P> Type : TEXT </P>
          */
         public static final String GTASK_ID = "gtask_id";
-
+        // 版本代码，类型为长整型整数
         /**
          * The version code
          * <P> Type : INTEGER (long) </P>
          */
         public static final String VERSION = "version";
     }
-
+     // 定义数据列的接口
     public interface DataColumns {
+        // 行的唯一 ID，类型为长整型整数
         /**
          * The unique ID for a row
          * <P> Type: INTEGER (long) </P>
          */
         public static final String ID = "_id";
-
+         // 此行表示的项目的 MIME 类型，类型为文本
         /**
          * The MIME type of the item represented by this row.
          * <P> Type: Text </P>
          */
         public static final String MIME_TYPE = "mime_type";
-
+        // 此数据所属笔记的引用 ID，类型为长整型整数
         /**
          * The reference id to note that this data belongs to
          * <P> Type: INTEGER (long) </P>
          */
         public static final String NOTE_ID = "note_id";
-
+        // 笔记或文件夹的创建日期，类型为长整型整数
         /**
          * Created data for note or folder
          * <P> Type: INTEGER (long) </P>
          */
         public static final String CREATED_DATE = "created_date";
-
+         // 最新修改日期，类型为长整型整数
         /**
          * Latest modified date
          * <P> Type: INTEGER (long) </P>
          */
         public static final String MODIFIED_DATE = "modified_date";
-
+        // 数据内容，类型为文本
         /**
          * Data's content
          * <P> Type: TEXT </P>
          */
         public static final String CONTENT = "content";
-
+        // 通用数据列，含义取决于 MIME_TYPE，用于整数数据类型
 
         /**
          * Generic data column, the meaning is {@link #MIMETYPE} specific, used for
@@ -211,28 +234,28 @@ public class Notes {
          * <P> Type: INTEGER </P>
          */
         public static final String DATA1 = "data1";
-
+        // 通用数据列，含义取决于 MIME_TYPE，用于整数数据类型
         /**
          * Generic data column, the meaning is {@link #MIMETYPE} specific, used for
          * integer data type
          * <P> Type: INTEGER </P>
          */
         public static final String DATA2 = "data2";
-
+        // 通用数据列，含义取决于 MIME_TYPE，用于文本数据类型
         /**
          * Generic data column, the meaning is {@link #MIMETYPE} specific, used for
          * TEXT data type
          * <P> Type: TEXT </P>
          */
         public static final String DATA3 = "data3";
-
+        // 通用数据列，含义取决于 MIME_TYPE，用于文本数据类型
         /**
          * Generic data column, the meaning is {@link #MIMETYPE} specific, used for
          * TEXT data type
          * <P> Type: TEXT </P>
          */
         public static final String DATA4 = "data4";
-
+        // 通用数据列，含义取决于 MIME_TYPE，用于文本数据类型
         /**
          * Generic data column, the meaning is {@link #MIMETYPE} specific, used for
          * TEXT data type
@@ -240,8 +263,10 @@ public class Notes {
          */
         public static final String DATA5 = "data5";
     }
+    // 文本笔记类，实现 DataColumns 接口
 
     public static final class TextNote implements DataColumns {
+        // 表示文本是否处于清单模式的模式，1 为清单模式，0 为正常模式，类型为整数
         /**
          * Mode to indicate the text in check list mode or not
          * <P> Type: Integer 1:check list mode 0: normal mode </P>
@@ -249,31 +274,32 @@ public class Notes {
         public static final String MODE = DATA1;
 
         public static final int MODE_CHECK_LIST = 1;
-
+        // 文本笔记的 Content Type（目录）
         public static final String CONTENT_TYPE = "vnd.android.cursor.dir/text_note";
-
+        // 文本笔记的 Content Item Type（项目）
         public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/text_note";
-
+        // 文本笔记的 Content 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>
          */
         public static final String CALL_DATE = DATA1;
-
+        // 通话记录的电话号码，类型为文本
         /**
          * Phone number for this record
          * <P> Type: TEXT </P>
          */
         public static final String PHONE_NUMBER = DATA3;
-
+        // 通话笔记的 Content Type（目录）
         public static final String CONTENT_TYPE = "vnd.android.cursor.dir/call_note";
-
+        // 通话笔记的 Content Item Type（项目）
         public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/call_note";
-
+        // 通话笔记的 Content Uri
         public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/call_note");
     }
 }

src/Notes-master/src/net/micode/notes/data/NotesDatabaseHelper.java

@@ -21,27 +21,28 @@ import android.content.Context;
 import android.database.sqlite.SQLiteDatabase;
 import android.database.sqlite.SQLiteOpenHelper;
 import android.util.Log;
-
+// 该类继承自 SQLiteOpenHelper，用于管理笔记应用的数据库创建、升级和相关操作
 import net.micode.notes.data.Notes.DataColumns;
 import net.micode.notes.data.Notes.DataConstants;
 import net.micode.notes.data.Notes.NoteColumns;
 
 
 public class NotesDatabaseHelper extends SQLiteOpenHelper {
+    // 数据库名称
     private static final String DB_NAME = "note.db";
-
+    // 数据库版本号
     private static final int DB_VERSION = 4;
-
+    // 定义数据库表名的接口
     public interface TABLE {
         public static final String NOTE = "note";
 
         public static final String DATA = "data";
     }
-
+    // 日志标签，用于在数据库操作过程中记录日志信息
     private static final String TAG = "NotesDatabaseHelper";
-
+    // 单例模式实例
     private static NotesDatabaseHelper mInstance;
-
+    // 创建笔记表的 SQL 语句
     private static final String CREATE_NOTE_TABLE_SQL =
         "CREATE TABLE " + TABLE.NOTE + "(" +
             NoteColumns.ID + " INTEGER PRIMARY KEY," +
@@ -62,7 +63,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
             NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''," +
             NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0" +
         ")";
-
+    // 创建数据表的 SQL 语句
     private static final String CREATE_DATA_TABLE_SQL =
         "CREATE TABLE " + TABLE.DATA + "(" +
             DataColumns.ID + " INTEGER PRIMARY KEY," +
@@ -77,11 +78,11 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
             DataColumns.DATA4 + " TEXT NOT NULL DEFAULT ''," +
             DataColumns.DATA5 + " TEXT NOT NULL DEFAULT ''" +
         ")";
-
+    // 在数据表上创建基于 note_id 的索引 SQL 语句，如果不存在则创建
     private static final String CREATE_DATA_NOTE_ID_INDEX_SQL =
         "CREATE INDEX IF NOT EXISTS note_id_index ON " +
         TABLE.DATA + "(" + DataColumns.NOTE_ID + ");";
-
+    // 当笔记移动到文件夹时增加文件夹笔记数量的触发器 SQL 语句
     /**
      * Increase folder's note count when move note to the folder
      */
@@ -93,7 +94,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
         "   SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" +
         "  WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" +
         " END";
-
+    // 当笔记从文件夹移出时减少文件夹笔记数量的触发器 SQL 语句
     /**
      * Decrease folder's note count when move note from folder
      */
@@ -106,7 +107,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
         "  WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID +
         "  AND " + NoteColumns.NOTES_COUNT + ">0" + ";" +
         " END";
-
+    // 当在文件夹中插入新笔记时增加文件夹笔记数量的触发器 SQL 语句
     /**
      * Increase folder's note count when insert new note to the folder
      */
@@ -118,7 +119,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
         "   SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" +
         "  WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" +
         " END";
-
+    // 当从文件夹中删除笔记时减少文件夹笔记数量的触发器 SQL 语句
     /**
      * Decrease folder's note count when delete note from the folder
      */
@@ -131,7 +132,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
         "  WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID +
         "  AND " + NoteColumns.NOTES_COUNT + ">0;" +
         " END";
-
+    // 当插入类型为笔记的数据时更新笔记内容的触发器 SQL 语句
     /**
      * Update note's content when insert data with type {@link DataConstants#NOTE}
      */
@@ -144,7 +145,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
         "   SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT +
         "  WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" +
         " END";
-
+    // 当笔记类型的数据更新时更新笔记内容的触发器 SQL 语句
     /**
      * Update note's content when data with {@link DataConstants#NOTE} type has changed
      */
@@ -157,7 +158,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
         "   SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT +
         "  WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" +
         " END";
-
+    // 当笔记类型的数据删除时更新笔记内容的触发器 SQL 语句
     /**
      * Update note's content when data with {@link DataConstants#NOTE} type has deleted
      */
@@ -170,7 +171,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
         "   SET " + NoteColumns.SNIPPET + "=''" +
         "  WHERE " + NoteColumns.ID + "=old." + DataColumns.NOTE_ID + ";" +
         " END";
-
+    // 当笔记被删除时删除其关联数据的触发器 SQL 语句
     /**
      * Delete datas belong to note which has been deleted
      */
@@ -181,7 +182,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
         "  DELETE FROM " + TABLE.DATA +
         "   WHERE " + DataColumns.NOTE_ID + "=old." + NoteColumns.ID + ";" +
         " END";
-
+    // 当文件夹被删除时删除其关联笔记的触发器 SQL 语句
     /**
      * Delete notes belong to folder which has been deleted
      */
@@ -192,7 +193,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
         "  DELETE FROM " + TABLE.NOTE +
         "   WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" +
         " END";
-
+    // 当文件夹被移动到垃圾桶文件夹时移动其关联笔记的触发器 SQL 语句
     /**
      * Move notes belong to folder which has been moved to trash folder
      */
@@ -205,18 +206,18 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
         "   SET " + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLER +
         "  WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" +
         " END";
-
+    // 构造函数，调用父类 SQLiteOpenHelper 的构造函数，传入上下文、数据库名称、游标工厂（这里为 null）和版本号
     public NotesDatabaseHelper(Context context) {
         super(context, DB_NAME, null, DB_VERSION);
     }
-
+    // 创建笔记表的方法，执行创建表的 SQL 语句，重新创建触发器，并创建系统文件夹
     public void createNoteTable(SQLiteDatabase db) {
         db.execSQL(CREATE_NOTE_TABLE_SQL);
         reCreateNoteTableTriggers(db);
         createSystemFolder(db);
         Log.d(TAG, "note table has been created");
     }
-
+    // 重新创建笔记表触发器的方法，先删除已存在的相关触发器，再创建新的触发器
     private void reCreateNoteTableTriggers(SQLiteDatabase db) {
         db.execSQL("DROP TRIGGER IF EXISTS increase_folder_count_on_update");
         db.execSQL("DROP TRIGGER IF EXISTS decrease_folder_count_on_update");
@@ -234,17 +235,17 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
         db.execSQL(FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER);
         db.execSQL(FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER);
     }
-
+    // 创建系统文件夹的方法，向笔记表中插入通话记录文件夹、根文件夹、临时文件夹和垃圾桶文件夹的记录
     private void createSystemFolder(SQLiteDatabase db) {
         ContentValues values = new ContentValues();
-
+        // 通话记录文件夹
         /**
          * call record foler for call notes
          */
         values.put(NoteColumns.ID, Notes.ID_CALL_RECORD_FOLDER);
         values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
         db.insert(TABLE.NOTE, null, values);
-
+        // 根文件夹
         /**
          * root folder which is default folder
          */
@@ -252,7 +253,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
         values.put(NoteColumns.ID, Notes.ID_ROOT_FOLDER);
         values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
         db.insert(TABLE.NOTE, null, values);
-
+        // 临时文件夹
         /**
          * temporary folder which is used for moving note
          */
@@ -260,7 +261,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
         values.put(NoteColumns.ID, Notes.ID_TEMPARAY_FOLDER);
         values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
         db.insert(TABLE.NOTE, null, values);
-
+        // 垃圾桶文件夹
         /**
          * create trash folder
          */
@@ -269,14 +270,14 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
         values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
         db.insert(TABLE.NOTE, null, values);
     }
-
+    // 创建数据表的方法，执行创建表的 SQL 语句，重新创建触发器，并创建索引
     public void createDataTable(SQLiteDatabase db) {
         db.execSQL(CREATE_DATA_TABLE_SQL);
         reCreateDataTableTriggers(db);
         db.execSQL(CREATE_DATA_NOTE_ID_INDEX_SQL);
         Log.d(TAG, "data table has been created");
     }
-
+    // 重新创建数据表触发器的方法，先删除已存在的相关触发器，再创建新的触发器
     private void reCreateDataTableTriggers(SQLiteDatabase db) {
         db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_insert");
         db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_update");
@@ -286,20 +287,20 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
         db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER);
         db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER);
     }
-
+    // 单例模式获取实例的方法，确保只有一个 NotesDatabaseHelper 实例存在
     static synchronized NotesDatabaseHelper getInstance(Context context) {
         if (mInstance == null) {
             mInstance = new NotesDatabaseHelper(context);
         }
         return mInstance;
     }
-
+    // 重写 onCreate 方法，在数据库首次创建时调用，创建笔记表和数据表
     @Override
     public void onCreate(SQLiteDatabase db) {
         createNoteTable(db);
         createDataTable(db);
     }
-
+    // 重写 onUpgrade 方法，在数据库版本升级时调用，根据不同的旧版本执行相应的升级操作
     @Override
     public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
         boolean reCreateTriggers = false;
@@ -307,7 +308,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
 
         if (oldVersion == 1) {
             upgradeToV2(db);
-            skipV2 = true; // this upgrade including the upgrade from v2 to v3
+            skipV2 = true; // 此次升级包含从 v2 到 v3 的升级
             oldVersion++;
         }
 
@@ -332,29 +333,29 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
                     + "fails");
         }
     }
-
+    // 从版本 1 升级到版本 2 的方法，删除旧表并重新创建新表
     private void upgradeToV2(SQLiteDatabase db) {
         db.execSQL("DROP TABLE IF EXISTS " + TABLE.NOTE);
         db.execSQL("DROP TABLE IF EXISTS " + TABLE.DATA);
         createNoteTable(db);
         createDataTable(db);
     }
-
+    // 从版本 2 升级到版本 3 的方法，删除无用触发器，添加 gtask_id 列，并添加垃圾桶系统文件夹
     private void upgradeToV3(SQLiteDatabase db) {
-        // drop unused triggers
+        // 删除无用触发器
         db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_insert");
         db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_delete");
         db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_update");
-        // add a column for gtask id
+        // 添加 gtask_id 列
         db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.GTASK_ID
                 + " TEXT NOT NULL DEFAULT ''");
-        // add a trash system folder
+        // 添加垃圾桶系统文件夹
         ContentValues values = new ContentValues();
         values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER);
         values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
         db.insert(TABLE.NOTE, null, values);
     }
-
+    // 从版本 3 升级到版本 4 的方法，添加 version 列
     private void upgradeToV4(SQLiteDatabase db) {
         db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.VERSION
                 + " INTEGER NOT NULL DEFAULT 0");

src/Notes-master/src/net/micode/notes/data/NotesProvider.java

@@ -34,14 +34,15 @@ import net.micode.notes.data.Notes.DataColumns;
 import net.micode.notes.data.Notes.NoteColumns;
 import net.micode.notes.data.NotesDatabaseHelper.TABLE;
 
-
+// 该类继承自 ContentProvider，用于在 Android 系统中提供笔记数据的增删改查功能，并处理搜索相关操作
 public class NotesProvider extends ContentProvider {
+    // 用于匹配不同的 Uri 模式的 UriMatcher 实例
     private static final UriMatcher mMatcher;
-
+    // 数据库帮助类实例，用于操作数据库
     private NotesDatabaseHelper mHelper;
-
+    // 日志标签，用于记录日志信息
     private static final String TAG = "NotesProvider";
-
+    // 定义不同 Uri 模式的匹配码
     private static final int URI_NOTE            = 1;
     private static final int URI_NOTE_ITEM       = 2;
     private static final int URI_DATA            = 3;
@@ -49,7 +50,7 @@ public class NotesProvider extends ContentProvider {
 
     private static final int URI_SEARCH          = 5;
     private static final int URI_SEARCH_SUGGEST  = 6;
-
+    // 静态代码块，用于初始化 UriMatcher，添加各种 Uri 模式的匹配规则
     static {
         mMatcher = new UriMatcher(UriMatcher.NO_MATCH);
         mMatcher.addURI(Notes.AUTHORITY, "note", URI_NOTE);
@@ -60,7 +61,8 @@ public class NotesProvider extends ContentProvider {
         mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY, URI_SEARCH_SUGGEST);
         mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY + "/*", URI_SEARCH_SUGGEST);
     }
-
+    // 搜索结果投影字符串，用于定义搜索结果中返回的列信息
+    // 包括笔记 ID、将笔记 ID 作为意图额外数据、修剪和替换换行符后的笔记摘要作为搜索建议的文本列、图标资源 ID、意图动作和意图数据类型
     /**
      * x'0A' represents the '\n' character in sqlite. For title and content in the search result,
      * we will trim '\n' and white space in order to show more information.
@@ -72,52 +74,61 @@ public class NotesProvider extends ContentProvider {
         + R.drawable.search_result + " AS " + SearchManager.SUGGEST_COLUMN_ICON_1 + ","
         + "'" + Intent.ACTION_VIEW + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_ACTION + ","
         + "'" + Notes.TextNote.CONTENT_TYPE + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_DATA;
-
+    // 搜索查询语句，用于从笔记表中查询符合搜索条件的笔记信息
+    // 搜索条件是笔记摘要包含指定字符串，且笔记不在垃圾桶文件夹中，并且是普通笔记类型
     private static String NOTES_SNIPPET_SEARCH_QUERY = "SELECT " + NOTES_SEARCH_PROJECTION
         + " FROM " + TABLE.NOTE
         + " WHERE " + NoteColumns.SNIPPET + " LIKE ?"
         + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER
         + " AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE;
-
+    // 重写 ContentProvider 的 onCreate 方法，在 ContentProvider 启动时调用
+    // 用于获取 NotesDatabaseHelper 的单例实例
     @Override
     public boolean onCreate() {
         mHelper = NotesDatabaseHelper.getInstance(getContext());
         return true;
     }
-
+    // 重写 ContentProvider 的 query 方法，用于处理数据查询请求
     @Override
     public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs,
             String sortOrder) {
         Cursor c = null;
         SQLiteDatabase db = mHelper.getReadableDatabase();
         String id = null;
+        // 根据 Uri 匹配码执行不同的查询操作
         switch (mMatcher.match(uri)) {
             case URI_NOTE:
+            // 查询笔记表，返回符合条件的游标
                 c = db.query(TABLE.NOTE, projection, selection, selectionArgs, null, null,
                         sortOrder);
                 break;
             case URI_NOTE_ITEM:
+                // 获取路径片段中的笔记 ID，查询指定 ID 的笔记
                 id = uri.getPathSegments().get(1);
                 c = db.query(TABLE.NOTE, projection, NoteColumns.ID + "=" + id
                         + parseSelection(selection), selectionArgs, null, null, sortOrder);
                 break;
             case URI_DATA:
+                // 查询数据表，返回符合条件的游标
                 c = db.query(TABLE.DATA, projection, selection, selectionArgs, null, null,
                         sortOrder);
                 break;
             case URI_DATA_ITEM:
+                // 获取路径片段中的数据 ID，查询指定 ID 的数据
                 id = uri.getPathSegments().get(1);
                 c = db.query(TABLE.DATA, projection, DataColumns.ID + "=" + id
                         + parseSelection(selection), selectionArgs, null, null, sortOrder);
                 break;
             case URI_SEARCH:
             case URI_SEARCH_SUGGEST:
+                // 检查是否指定了不允许的参数，如果指定则抛出异常
                 if (sortOrder != null || projection != null) {
                     throw new IllegalArgumentException(
                             "do not specify sortOrder, selection, selectionArgs, or projection" + "with this query");
                 }
 
                 String searchString = null;
+                // 根据 Uri 匹配码获取搜索字符串
                 if (mMatcher.match(uri) == URI_SEARCH_SUGGEST) {
                     if (uri.getPathSegments().size() > 1) {
                         searchString = uri.getPathSegments().get(1);
@@ -125,12 +136,13 @@ public class NotesProvider extends ContentProvider {
                 } else {
                     searchString = uri.getQueryParameter("pattern");
                 }
-
+                // 如果搜索字符串为空，则返回 null
                 if (TextUtils.isEmpty(searchString)) {
                     return null;
                 }
 
                 try {
+                    // 格式化搜索字符串，执行原始查询并返回游标
                     searchString = String.format("%%%s%%", searchString);
                     c = db.rawQuery(NOTES_SNIPPET_SEARCH_QUERY,
                             new String[] { searchString });
@@ -139,61 +151,71 @@ public class NotesProvider extends ContentProvider {
                 }
                 break;
             default:
+                // 如果 Uri 不匹配任何已知模式，则抛出异常
                 throw new IllegalArgumentException("Unknown URI " + uri);
         }
+        // 如果游标不为空，则设置通知 Uri，以便在数据变化时接收通知
         if (c != null) {
             c.setNotificationUri(getContext().getContentResolver(), uri);
         }
         return c;
     }
-
+    // 重写 ContentProvider 的 insert 方法，用于处理数据插入请求
     @Override
     public Uri insert(Uri uri, ContentValues values) {
         SQLiteDatabase db = mHelper.getWritableDatabase();
         long dataId = 0, noteId = 0, insertedId = 0;
+        // 根据 Uri 匹配码执行不同的插入操作
         switch (mMatcher.match(uri)) {
             case URI_NOTE:
+                // 插入笔记数据，获取插入的笔记 ID
                 insertedId = noteId = db.insert(TABLE.NOTE, null, values);
                 break;
             case URI_DATA:
+                // 获取数据所属的笔记 ID，如果不存在则记录错误日志
                 if (values.containsKey(DataColumns.NOTE_ID)) {
                     noteId = values.getAsLong(DataColumns.NOTE_ID);
                 } else {
                     Log.d(TAG, "Wrong data format without note id:" + values.toString());
                 }
+                // 插入数据，获取插入的数据 ID
                 insertedId = dataId = db.insert(TABLE.DATA, null, values);
                 break;
             default:
+                // 如果 Uri 不匹配任何已知模式，则抛出异常
                 throw new IllegalArgumentException("Unknown URI " + uri);
         }
-        // Notify the note uri
+        // 如果插入了笔记数据，则通知笔记 Uri 数据变化
         if (noteId > 0) {
             getContext().getContentResolver().notifyChange(
                     ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null);
         }
-
-        // Notify the data uri
+        // 如果插入了数据，则通知数据 Uri 数据变化
         if (dataId > 0) {
             getContext().getContentResolver().notifyChange(
                     ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null);
         }
-
+        // 返回插入数据后的 Uri，包含插入的 ID
         return ContentUris.withAppendedId(uri, insertedId);
     }
-
+    // 重写 ContentProvider 的 delete 方法，用于处理数据删除请求
     @Override
     public int delete(Uri uri, String selection, String[] selectionArgs) {
         int count = 0;
         String id = null;
         SQLiteDatabase db = mHelper.getWritableDatabase();
         boolean deleteData = false;
+        // 根据 Uri 匹配码执行不同的删除操作
         switch (mMatcher.match(uri)) {
             case URI_NOTE:
+                // 添加额外的条件，确保只删除有效 ID 的笔记
                 selection = "(" + selection + ") AND " + NoteColumns.ID + ">0 ";
                 count = db.delete(TABLE.NOTE, selection, selectionArgs);
                 break;
             case URI_NOTE_ITEM:
+                // 获取路径片段中的笔记 ID
                 id = uri.getPathSegments().get(1);
+                // 如果笔记 ID 小于等于 0，则不允许删除（可能是系统文件夹）
                 /**
                  * ID that smaller than 0 is system folder which is not allowed to
                  * trash
@@ -206,18 +228,22 @@ public class NotesProvider extends ContentProvider {
                         NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs);
                 break;
             case URI_DATA:
+                // 删除数据，设置标志位
                 count = db.delete(TABLE.DATA, selection, selectionArgs);
                 deleteData = true;
                 break;
             case URI_DATA_ITEM:
+                // 获取路径片段中的数据 ID
                 id = uri.getPathSegments().get(1);
                 count = db.delete(TABLE.DATA,
                         DataColumns.ID + "=" + id + parseSelection(selection), selectionArgs);
                 deleteData = true;
                 break;
             default:
+                // 如果 Uri 不匹配任何已知模式，则抛出异常
                 throw new IllegalArgumentException("Unknown URI " + uri);
         }
+        // 如果删除了数据且有数据被删除，则通知笔记 Uri 和删除的 Uri 数据变化
         if (count > 0) {
             if (deleteData) {
                 getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null);
@@ -226,38 +252,44 @@ public class NotesProvider extends ContentProvider {
         }
         return count;
     }
-
+    // 重写 ContentProvider 的 update 方法，用于处理数据更新请求
     @Override
     public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) {
         int count = 0;
         String id = null;
         SQLiteDatabase db = mHelper.getWritableDatabase();
         boolean updateData = false;
+        // 根据 Uri 匹配码执行不同的更新操作
         switch (mMatcher.match(uri)) {
             case URI_NOTE:
+                // 增加笔记版本号，执行更新操作
                 increaseNoteVersion(-1, selection, selectionArgs);
                 count = db.update(TABLE.NOTE, values, selection, selectionArgs);
                 break;
             case URI_NOTE_ITEM:
+                // 获取路径片段中的笔记 ID，增加笔记版本号，执行更新操作
                 id = uri.getPathSegments().get(1);
                 increaseNoteVersion(Long.valueOf(id), selection, selectionArgs);
                 count = db.update(TABLE.NOTE, values, NoteColumns.ID + "=" + id
                         + parseSelection(selection), selectionArgs);
                 break;
             case URI_DATA:
+                // 更新数据，设置标志位
                 count = db.update(TABLE.DATA, values, selection, selectionArgs);
                 updateData = true;
                 break;
             case URI_DATA_ITEM:
+                // 获取路径片段中的数据 ID，更新数据
                 id = uri.getPathSegments().get(1);
                 count = db.update(TABLE.DATA, values, DataColumns.ID + "=" + id
                         + parseSelection(selection), selectionArgs);
                 updateData = true;
                 break;
             default:
+                // 如果 Uri 不匹配任何已知模式，则抛出异常
                 throw new IllegalArgumentException("Unknown URI " + uri);
         }
-
+        // 如果更新了数据且有数据被更新，则通知笔记 Uri 和更新的 Uri 数据变化
         if (count > 0) {
             if (updateData) {
                 getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null);
@@ -266,11 +298,11 @@ public class NotesProvider extends ContentProvider {
         }
         return count;
     }
-
+    // 辅助方法，用于解析选择条件，添加括号和 AND 连接符
     private String parseSelection(String selection) {
         return (!TextUtils.isEmpty(selection) ? " AND (" + selection + ')' : "");
     }
-
+    // 增加笔记版本号的方法，根据指定的笔记 ID 和选择条件构建更新 SQL 语句并执行
     private void increaseNoteVersion(long id, String selection, String[] selectionArgs) {
         StringBuilder sql = new StringBuilder(120);
         sql.append("UPDATE ");
@@ -295,10 +327,10 @@ public class NotesProvider extends ContentProvider {
 
         mHelper.getWritableDatabase().execSQL(sql.toString());
     }
-
+    // 重写 ContentProvider 的 getType 方法，目前未实现，返回 null
     @Override
     public String getType(Uri uri) {
-        // TODO Auto-generated method stub
+        // TODO Auto-generated method stub    
         return null;
     }