diff --git a/app/src/main/java/net/micode/notes/gtask/data/MetaData.java b/app/src/main/java/net/micode/notes/gtask/data/MetaData.java index fc75821..2fb1601 100644 --- a/app/src/main/java/net/micode/notes/gtask/data/MetaData.java +++ b/app/src/main/java/net/micode/notes/gtask/data/MetaData.java @@ -27,7 +27,7 @@ import org.json.JSONObject; public class MetaData extends Task { /* - * 功能:得到类的简写名称存入字符串TAG中 + * 功能:得到类的简称存入字符串TAG中 * 过程:调用getSimpleName ()函数 */ private final static String TAG = MetaData.class.getSimpleName(); diff --git a/app/src/main/java/net/micode/notes/gtask/data/Node.java b/app/src/main/java/net/micode/notes/gtask/data/Node.java index 63950e0..31f5be8 100644 --- a/app/src/main/java/net/micode/notes/gtask/data/Node.java +++ b/app/src/main/java/net/micode/notes/gtask/data/Node.java @@ -20,6 +20,9 @@ import android.database.Cursor; import org.json.JSONObject; +/** + * 定义了一些有关同步操作的常量,Node为同步操作的基础类 + */ public abstract class Node { public static final int SYNC_ACTION_NONE = 0; diff --git a/app/src/main/java/net/micode/notes/gtask/data/SqlData.java b/app/src/main/java/net/micode/notes/gtask/data/SqlData.java index 211eba2..72871ea 100644 --- a/app/src/main/java/net/micode/notes/gtask/data/SqlData.java +++ b/app/src/main/java/net/micode/notes/gtask/data/SqlData.java @@ -34,7 +34,9 @@ import net.micode.notes.gtask.exception.ActionFailureException; import org.json.JSONException; import org.json.JSONObject; - +/** + * 功能:支持最底层的数据库操作,在逻辑关系上是Sqldata是Node类的子集 + */ public class SqlData { private static final String TAG = SqlData.class.getSimpleName(); diff --git a/app/src/main/java/net/micode/notes/gtask/data/SqlNote.java b/app/src/main/java/net/micode/notes/gtask/data/SqlNote.java index 3ff745e..202b72a 100644 --- a/app/src/main/java/net/micode/notes/gtask/data/SqlNote.java +++ b/app/src/main/java/net/micode/notes/gtask/data/SqlNote.java @@ -37,7 +37,9 @@ import org.json.JSONObject; import java.util.ArrayList; - +/** + * 功能:支持最底层的数据库操作,从SqlData中具体出的便签类数据,是真正意义上的便签数据 + */ public class SqlNote { private static final String TAG = SqlNote.class.getSimpleName(); diff --git a/app/src/main/java/net/micode/notes/gtask/data/Task.java b/app/src/main/java/net/micode/notes/gtask/data/Task.java index 6a19454..6207612 100644 --- a/app/src/main/java/net/micode/notes/gtask/data/Task.java +++ b/app/src/main/java/net/micode/notes/gtask/data/Task.java @@ -31,7 +31,9 @@ import org.json.JSONArray; import org.json.JSONException; import org.json.JSONObject; - +/** + * 与Node是父子关系,继承了原有的属性和方法,并在此基础上定义更加具体的功能 + */ public class Task extends Node { private static final String TAG = Task.class.getSimpleName(); diff --git a/app/src/main/java/net/micode/notes/gtask/data/TaskList.java b/app/src/main/java/net/micode/notes/gtask/data/TaskList.java index 4ea21c5..0f5dbe9 100644 --- a/app/src/main/java/net/micode/notes/gtask/data/TaskList.java +++ b/app/src/main/java/net/micode/notes/gtask/data/TaskList.java @@ -29,12 +29,16 @@ import org.json.JSONObject; import java.util.ArrayList; - +/** + * 继承自Node,拓展了一些有关Task列表的基础操作 + */ public class TaskList extends Node { private static final String TAG = TaskList.class.getSimpleName(); private int mIndex; - + /* + * 创建一个以Task为基本元素的ArrayList + */ private ArrayList mChildren; public TaskList() { diff --git a/app/src/main/java/net/micode/notes/tool/BackupUtils.java b/app/src/main/java/net/micode/notes/tool/BackupUtils.java index d2f3d68..6d8ea0a 100644 --- a/app/src/main/java/net/micode/notes/tool/BackupUtils.java +++ b/app/src/main/java/net/micode/notes/tool/BackupUtils.java @@ -40,9 +40,13 @@ public class BackupUtils { private static final String TAG = "BackupUtils"; // Singleton stuff private static BackupUtils sInstance; - + /* + * synchronized关键字代表该方法加锁: + * 任何一个线程运行到该方法都得检测是否在其它线程运用到了该方法 + */ public static synchronized BackupUtils getInstance(Context context) { if (sInstance == null) { + //如果当前备份缺失,则重新定义一个 sInstance = new BackupUtils(context); } return sInstance; @@ -67,12 +71,16 @@ public class BackupUtils { private BackupUtils(Context context) { mTextExport = new TextExport(context); - } - + }//构造函数 + /* + * 判断外部存储功能是否可用 + */ private static boolean externalStorageAvailable() { return Environment.MEDIA_MOUNTED.equals(Environment.getExternalStorageState()); } - + /* + * 获取有关文本的一些信息 + */ public int exportToText() { return mTextExport.exportToText(); } @@ -322,7 +330,9 @@ public class BackupUtils { DateFormat.format(context.getString(R.string.format_date_ymd), System.currentTimeMillis()))); File file = new File(sb.toString()); - + /* + * 如果文件不存在则抛出异常 + */ try { if (!filedir.exists()) { filedir.mkdir(); diff --git a/app/src/main/java/net/micode/notes/tool/DataUtils.java b/app/src/main/java/net/micode/notes/tool/DataUtils.java index 378bfb2..8a27ab8 100644 --- a/app/src/main/java/net/micode/notes/tool/DataUtils.java +++ b/app/src/main/java/net/micode/notes/tool/DataUtils.java @@ -34,10 +34,16 @@ import net.micode.notes.ui.NotesListAdapter.AppWidgetAttribute; import java.util.ArrayList; import java.util.HashSet; +/** + * 数据工具包 + * 功能:定义了一些用来处理便签数据的方法(包括删除、转移、计数、查找、校验)以及异常处理 + */ public class DataUtils { public static final String TAG = "DataUtils"; - + /* + * 此方法用于批删除便签(包括一些特殊情况的处理) + */ public static boolean batchDeleteNotes(ContentResolver resolver, HashSet ids) { if (ids == null) { Log.d(TAG, "the ids is null"); @@ -50,6 +56,7 @@ public class DataUtils { ArrayList operationList = new ArrayList(); for (long id : ids) { + //若发现是根文件则跳过此执行语句 if (id == Notes.ID_ROOT_FOLDER) { Log.e(TAG, "Don't delete system folder root"); continue; diff --git a/app/src/main/java/net/micode/notes/tool/GTaskStringUtils.java b/app/src/main/java/net/micode/notes/tool/GTaskStringUtils.java index 666b729..a9e2f17 100644 --- a/app/src/main/java/net/micode/notes/tool/GTaskStringUtils.java +++ b/app/src/main/java/net/micode/notes/tool/GTaskStringUtils.java @@ -16,6 +16,9 @@ package net.micode.notes.tool; +/** + * 定义了一些静态字符串常量,为jsonObject提供了键,是一种编程规范 + */ public class GTaskStringUtils { public final static String GTASK_JSON_ACTION_ID = "action_id"; diff --git a/app/src/main/java/net/micode/notes/tool/ResourceParser.java b/app/src/main/java/net/micode/notes/tool/ResourceParser.java index ea5fc30..09c8fb8 100644 --- a/app/src/main/java/net/micode/notes/tool/ResourceParser.java +++ b/app/src/main/java/net/micode/notes/tool/ResourceParser.java @@ -22,6 +22,10 @@ import android.preference.PreferenceManager; import net.micode.notes.R; import net.micode.notes.ui.activities.NotesPreferenceActivity; +/** + * 资源分析器 + * 功能:获取资源并将其应用的进程中 + */ public class ResourceParser { public static final int YELLOW = 0;