version2 第二周文档1

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/data/Contact.java

@@ -23,10 +23,10 @@ import android.provider.ContactsContract.Data;
 import android.telephony.PhoneNumberUtils;
 import android.util.Log;
 
-import java.util.HashMap;
+import java.util.HashMap;//
 
-public class Contact {
+public class Contact {//用于记录联系人的数据库
-    private static HashMap<String, String> sContactCache;
+    private static HashMap<String, String> sContactCache;//定义
     private static final String TAG = "Contact";
 
     private static final String CALLER_ID_SELECTION = "PHONE_NUMBERS_EQUAL(" + Phone.NUMBER

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/data/Notes.java

@@ -17,7 +17,7 @@
 package net.micode.notes.data;
 
 import android.net.Uri;
-public class Notes {
+public class Notes {//用于记录便签的数据库，记录便签中的数据
     public static final String AUTHORITY = "micode_notes";
     public static final String TAG = "Notes";
     public static final int TYPE_NOTE     = 0;

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java

@@ -27,7 +27,7 @@ import net.micode.notes.data.Notes.DataConstants;
 import net.micode.notes.data.Notes.NoteColumns;
 
 
-public class NotesDatabaseHelper extends SQLiteOpenHelper {
+public class NotesDatabaseHelper extends SQLiteOpenHelper {//便签信息提供类、可以理解为管理
     private static final String DB_NAME = "note.db";
 
     private static final int DB_VERSION = 4;

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/data/NotesProvider.java

@@ -35,7 +35,7 @@ import net.micode.notes.data.Notes.NoteColumns;
 import net.micode.notes.data.NotesDatabaseHelper.TABLE;
 
 
-public class NotesProvider extends ContentProvider {
+public class NotesProvider extends ContentProvider {//数据库帮助类、帮助创建、处理数据库
     private static final UriMatcher mMatcher;
 
     private NotesDatabaseHelper mHelper;

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/gtask/data/MetaData.java

@@ -25,16 +25,16 @@ import org.json.JSONException;
 import org.json.JSONObject;
 
 
-public class MetaData extends Task {
+public class MetaData extends Task {//同步任务
-    private final static String TAG = MetaData.class.getSimpleName();
+    private final static String TAG = MetaData.class.getSimpleName();//调用getSimpleName函数得到简单的类名
 
     private String mRelatedGid = null;
 
-    public void setMeta(String gid, JSONObject metaInfo) {
+    public void setMeta(String gid, JSONObject metaInfo) {//调用JSONObject库函数put ()，Task类中的setNotes ()和setName ()函数设置数据、生成元数据库
         try {
-            metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid);
+            metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid);//存放键值对
         } catch (JSONException e) {
-            Log.e(TAG, "failed to put related gid");
+            Log.e(TAG, "failed to put related gid");//打印错误信息
         }
         setNotes(metaInfo.toString());
         setName(GTaskStringUtils.META_NOTE_NAME);

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/gtask/data/Node.java

@@ -20,7 +20,7 @@ import android.database.Cursor;
 
 import org.json.JSONObject;
 
-public abstract class Node {
+public abstract class Node {//定义同步操作常量，区分在本地或云端的各种操作、错误信息
     public static final int SYNC_ACTION_NONE = 0;
 
     public static final int SYNC_ACTION_ADD_REMOTE = 1;

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/gtask/data/SqlData.java

@@ -35,7 +35,7 @@ import org.json.JSONException;
 import org.json.JSONObject;
 
 
-public class SqlData {
+public class SqlData {//对小米便签底层数据库进行操作、sqlNote是sqlData的子集（节点），sqlData可以看作是数据的数据
     private static final String TAG = SqlData.class.getSimpleName();
 
     private static final int INVALID_ID = -99999;
@@ -71,7 +71,7 @@ public class SqlData {
 
     private ContentValues mDiffDataValues;
 
-    public SqlData(Context context) {
+    public SqlData(Context context) {//一系列用于初始化数据的构造函数和数据处理函数
         mContentResolver = context.getContentResolver();
         mIsCreate = true;
         mDataId = INVALID_ID;

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/gtask/data/SqlNote.java

@@ -38,7 +38,7 @@ import org.json.JSONObject;
 import java.util.ArrayList;
 
 
-public class SqlNote {
+public class SqlNote {//与sqlData相似，sqlNote主要用于管理数据库中的便签数据
     private static final String TAG = SqlNote.class.getSimpleName();
 
     private static final int INVALID_ID = -99999;

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/gtask/data/Task.java

@@ -32,7 +32,7 @@ import org.json.JSONException;
 import org.json.JSONObject;
 
 
-public class Task extends Node {
+public class Task extends Node {//用于管理同步任务、将任务中的各种操作包装成JSON对象、获取同步信息
     private static final String TAG = Task.class.getSimpleName();
 
     private boolean mCompleted;

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/gtask/data/TaskList.java

@@ -30,7 +30,7 @@ import org.json.JSONObject;
 import java.util.ArrayList;
 
 
-public class TaskList extends Node {
+public class TaskList extends Node {//同步任务列表、便于管理task任务
     private static final String TAG = TaskList.class.getSimpleName();
 
     private int mIndex;
@@ -43,7 +43,7 @@ public class TaskList extends Node {
         mIndex = 1;
     }
 
-    public JSONObject getCreateAction(int actionId) {
+    public JSONObject getCreateAction(int actionId) {//生成包含数据的JSONObject实体
         JSONObject js = new JSONObject();
 
         try {

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/gtask/exception/ActionFailureException.java

@@ -16,7 +16,7 @@
 
 package net.micode.notes.gtask.exception;
 
-public class ActionFailureException extends RuntimeException {
+public class ActionFailureException extends RuntimeException {//小米便签运行过程中的运行异常处理
     private static final long serialVersionUID = 4425249765923293627L;
 
     public ActionFailureException() {
@@ -27,7 +27,7 @@ public class ActionFailureException extends RuntimeException {
         super(paramString);
     }
 
-    public ActionFailureException(String paramString, Throwable paramThrowable) {
+    public ActionFailureException(String paramString, Throwable paramThrowable) {//用super来引用父类成分、用this引用当前对象
         super(paramString, paramThrowable);
     }
 }

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/gtask/exception/NetworkFailureException.java

@@ -16,7 +16,7 @@
 
 package net.micode.notes.gtask.exception;
 
-public class NetworkFailureException extends Exception {
+public class NetworkFailureException extends Exception {//小米便签运行过程中的网络异常处理
     private static final long serialVersionUID = 2107610287180234136L;
 
     public NetworkFailureException() {

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/gtask/remote/GTaskASyncTask.java

@@ -28,8 +28,14 @@ import net.micode.notes.R;
 import net.micode.notes.ui.NotesListActivity;
 import net.micode.notes.ui.NotesPreferenceActivity;
 
+/*
+ private void showNotification(int tickerId, String content) 向用户提示当前同步的状态，是一个用于交互的方法
+ protected Integer doInBackground(Void... unused) 此方法在后台线程执行，完成任务的主要工作，通常需要较长的时间
+ protected void onProgressUpdate(String... progress)  可以使用进度条增加用户体验度。 此方法在主线程执行，用于显示任务执行的进度。
+ protected void onPostExecute(Integer result)  相当于Handler 处理UI的方式，在这里面可以使用在doInBackground 得到的结果处理操作UI
+*/
 
-public class GTaskASyncTask extends AsyncTask<Void, String, Integer> {
+public class GTaskASyncTask extends AsyncTask<Void, String, Integer> {//异步操作类，用于实现Gtask的异步操作
 
     private static int GTASK_SYNC_NOTIFICATION_ID = 5234235;
 

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/gtask/remote/GTaskClient.java

@@ -61,7 +61,7 @@ import java.util.zip.Inflater;
 import java.util.zip.InflaterInputStream;
 
 
-public class GTaskClient {
+public class GTaskClient {//Gtask客户端、用于Gtask的登录操作，进行Gtask的各种操作以及获取任务和任务列表的内容
     private static final String TAG = GTaskClient.class.getSimpleName();
 
     private static final String GTASK_URL = "https://mail.google.com/tasks/";

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/gtask/remote/GTaskManager.java

@@ -48,7 +48,7 @@ import java.util.Iterator;
 import java.util.Map;
 
 
-public class GTaskManager {
+public class GTaskManager {//Gtask管理，负责进行本地和远程Gtask的各种操作
     private static final String TAG = GTaskManager.class.getSimpleName();
 
     public static final int STATE_SUCCESS = 0;
@@ -111,6 +111,14 @@ public class GTaskManager {
         mActivity = activity;
     }
 
+    /**
+     * 核心函数
+     * 功能：实现了本地同步操作和远端同步操作
+     * @author TTS
+     * @param context-----获取上下文
+     * @param asyncTask-------用于同步的异步操作类
+     * @return int
+     */
     public int sync(Context context, GTaskASyncTask asyncTask) {
         if (mSyncing) {
             Log.d(TAG, "Sync is in progress");

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/gtask/remote/GTaskSyncService.java

@@ -23,7 +23,23 @@ import android.content.Intent;
 import android.os.Bundle;
 import android.os.IBinder;
 
-public class GTaskSyncService extends Service {
+/*
+ * Service是在一段不定的时间运行在后台，不和用户交互的应用组件
+ * 主要方法：
+ * private void startSync()  启动一个同步工作
+ * private void cancelSync() 取消同步
+ * public void onCreate()
+ * public int onStartCommand(Intent intent, int flags, int startId)  service生命周期的组成部分，相当于重启service（比如在被暂停之后），而不是创建一个新的service
+ * public void onLowMemory()  在没有内存的情况下如果存在service则结束掉这的service
+ * public IBinder onBind()
+ * public void sendBroadcast(String msg)   发送同步的相关通知
+ * public static void startSync(Activity activity)
+ * public static void cancelSync(Context context)
+ * public static boolean isSyncing()  判读是否在进行同步
+ * public static String getProgressString()  获取当前进度的信息
+ */
+
+public class GTaskSyncService extends Service {//Gtask同步服务
     public final static String ACTION_STRING_NAME = "sync_action_type";
 
     public final static int ACTION_START_SYNC = 0;

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/model/Note.java

@@ -34,7 +34,7 @@ import net.micode.notes.data.Notes.TextNote;
 import java.util.ArrayList;
 
 
-public class Note {
+public class Note {//单个便签项模型
     private ContentValues mNoteDiffValues;
     private NoteData mNoteData;
     private static final String TAG = "Note";

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/model/WorkingNote.java

@@ -32,7 +32,7 @@ import net.micode.notes.data.Notes.TextNote;
 import net.micode.notes.tool.ResourceParser.NoteBgResources;
 
 
-public class WorkingNote {
+public class WorkingNote {//当前活动便签项模型
     // Note for the working note
     private Note mNote;
     // Note Id

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

@@ -36,7 +36,7 @@ import java.io.IOException;
 import java.io.PrintStream;
 
 
-public class BackupUtils {
+public class BackupUtils {//备份工具类，用于备份数据
     private static final String TAG = "BackupUtils";
     // Singleton stuff
     private static BackupUtils sInstance;

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

@@ -35,7 +35,7 @@ import java.util.ArrayList;
 import java.util.HashSet;
 
 
-public class DataUtils {
+public class DataUtils {//便签数据处理工具类，封装了各种数据的操作函数
     public static final String TAG = "DataUtils";
     public static boolean batchDeleteNotes(ContentResolver resolver, HashSet<Long> ids) {
         if (ids == null) {

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

@@ -16,7 +16,7 @@
 
 package net.micode.notes.tool;
 
-public class GTaskStringUtils {
+public class GTaskStringUtils {//同步任务字符串工具类，为JSONObject提供string对象
 
     public final static String GTASK_JSON_ACTION_ID = "action_id";
 

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

@@ -22,7 +22,7 @@ import android.preference.PreferenceManager;
 import net.micode.notes.R;
 import net.micode.notes.ui.NotesPreferenceActivity;
 
-public class ResourceParser {
+public class ResourceParser {//界面元素解析工具类，获取资源供程序调用
 
     public static final int YELLOW           = 0;
     public static final int BLUE             = 1;

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/ui/AlarmAlertActivity.java

@@ -40,7 +40,7 @@ import net.micode.notes.tool.DataUtils;
 import java.io.IOException;
 
 
-public class AlarmAlertActivity extends Activity implements OnClickListener, OnDismissListener {
+public class AlarmAlertActivity extends Activity implements OnClickListener, OnDismissListener {//闹钟提醒界面
     private long mNoteId;
     private String mSnippet;
     private static final int SNIPPET_PREW_MAX_LEN = 60;

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/ui/AlarmInitReceiver.java

@@ -28,7 +28,7 @@ import net.micode.notes.data.Notes;
 import net.micode.notes.data.Notes.NoteColumns;
 
 
-public class AlarmInitReceiver extends BroadcastReceiver {
+public class AlarmInitReceiver extends BroadcastReceiver {//闹钟启动消息接收器
 
     private static final String [] PROJECTION = new String [] {
         NoteColumns.ID,

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/ui/AlarmReceiver.java

@@ -20,7 +20,7 @@ import android.content.BroadcastReceiver;
 import android.content.Context;
 import android.content.Intent;
 
-public class AlarmReceiver extends BroadcastReceiver {
+public class AlarmReceiver extends BroadcastReceiver {//闹钟提醒接收器
     @Override
     public void onReceive(Context context, Intent intent) {
         intent.setClass(context, AlarmAlertActivity.class);

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/ui/DateTimePicker.java

@@ -28,7 +28,7 @@ import android.view.View;
 import android.widget.FrameLayout;
 import android.widget.NumberPicker;
 
-public class DateTimePicker extends FrameLayout {
+public class DateTimePicker extends FrameLayout {//设置提醒时间
 
     private static final boolean DEFAULT_ENABLE_STATE = true;
 

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/ui/DateTimePickerDialog.java

@@ -29,7 +29,7 @@ import android.content.DialogInterface.OnClickListener;
 import android.text.format.DateFormat;
 import android.text.format.DateUtils;
 
-public class DateTimePickerDialog extends AlertDialog implements OnClickListener {
+public class DateTimePickerDialog extends AlertDialog implements OnClickListener {//设置提醒时间的对话框界面
 
     private Calendar mDate = Calendar.getInstance();
     private boolean mIs24HourView;

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/ui/DropdownMenu.java

@@ -27,7 +27,7 @@ import android.widget.PopupMenu.OnMenuItemClickListener;
 
 import net.micode.notes.R;
 
-public class DropdownMenu {
+public class DropdownMenu {//下拉菜单界面
     private Button mButton;
     private PopupMenu mPopupMenu;
     private Menu mMenu;

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/ui/FoldersListAdapter.java

@@ -29,7 +29,7 @@ import net.micode.notes.data.Notes;
 import net.micode.notes.data.Notes.NoteColumns;
 
 
-public class FoldersListAdapter extends CursorAdapter {
+public class FoldersListAdapter extends CursorAdapter {//文件夹列表链接器（链接数据库）
     public static final String [] PROJECTION = {
         NoteColumns.ID,
         NoteColumns.SNIPPET

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/ui/NoteEditActivity.java

@@ -73,7 +73,7 @@ import java.util.regex.Pattern;
 
 
 public class NoteEditActivity extends Activity implements OnClickListener,
-        NoteSettingChangedListener, OnTextViewChangeListener {
+        NoteSettingChangedListener, OnTextViewChangeListener {//便签编辑器
     private class HeadViewHolder {
         public TextView tvModified;
 

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/ui/NoteEditText.java

@@ -37,7 +37,7 @@ import net.micode.notes.R;
 import java.util.HashMap;
 import java.util.Map;
 
-public class NoteEditText extends EditText {
+public class NoteEditText extends EditText {//便签编辑界面
     private static final String TAG = "NoteEditText";
     private int mIndex;
     private int mSelectionStartBeforeDelete;

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/ui/NoteItemData.java

@@ -26,7 +26,7 @@ import net.micode.notes.data.Notes.NoteColumns;
 import net.micode.notes.tool.DataUtils;
 
 
-public class NoteItemData {
+public class NoteItemData {//便签项数据
     static final String [] PROJECTION = new String [] {
         NoteColumns.ID,
         NoteColumns.ALERTED_DATE,

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/ui/NotesListActivity.java

@@ -78,7 +78,7 @@ import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.util.HashSet;
 
-public class NotesListActivity extends Activity implements OnClickListener, OnItemLongClickListener {
+public class NotesListActivity extends Activity implements OnClickListener, OnItemLongClickListener {//主界面，实现处理列表的活动
     private static final int FOLDER_NOTE_LIST_QUERY_TOKEN = 0;
 
     private static final int FOLDER_LIST_QUERY_TOKEN      = 1;

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/ui/NotesListAdapter.java

@@ -31,7 +31,7 @@ import java.util.HashSet;
 import java.util.Iterator;
 
 
-public class NotesListAdapter extends CursorAdapter {
+public class NotesListAdapter extends CursorAdapter {//便签列表链接器（链接数据库）
     private static final String TAG = "NotesListAdapter";
     private Context mContext;
     private HashMap<Integer, Boolean> mSelectedIndex;

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/ui/NotesListItem.java

@@ -30,7 +30,7 @@ import net.micode.notes.tool.DataUtils;
 import net.micode.notes.tool.ResourceParser.NoteItemBgResources;
 
 
-public class NotesListItem extends LinearLayout {
+public class NotesListItem extends LinearLayout {//便签列表项
     private ImageView mAlert;
     private TextView mTitle;
     private TextView mTime;

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/ui/NotesPreferenceActivity.java

@@ -48,7 +48,7 @@ import net.micode.notes.data.Notes.NoteColumns;
 import net.micode.notes.gtask.remote.GTaskSyncService;
 
 
-public class NotesPreferenceActivity extends PreferenceActivity {
+public class NotesPreferenceActivity extends PreferenceActivity {//便签同步的设置界面
     public static final String PREFERENCE_NAME = "notes_preferences";
 
     public static final String PREFERENCE_SYNC_ACCOUNT_NAME = "pref_key_account_name";

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/widget/NoteWidgetProvider.java

@@ -32,7 +32,7 @@ import net.micode.notes.tool.ResourceParser;
 import net.micode.notes.ui.NoteEditActivity;
 import net.micode.notes.ui.NotesListActivity;
 
-public abstract class NoteWidgetProvider extends AppWidgetProvider {
+public abstract class NoteWidgetProvider extends AppWidgetProvider {//桌面挂件
     public static final String [] PROJECTION = new String [] {
         NoteColumns.ID,
         NoteColumns.BG_COLOR_ID,

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/widget/NoteWidgetProvider_2x.java

@@ -24,7 +24,7 @@ import net.micode.notes.data.Notes;
 import net.micode.notes.tool.ResourceParser;
 
 
-public class NoteWidgetProvider_2x extends NoteWidgetProvider {
+public class NoteWidgetProvider_2x extends NoteWidgetProvider {//2倍大小的桌面挂件
     @Override
     public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
         super.update(context, appWidgetManager, appWidgetIds);

src/MiNotes-master/MiNotes-master/app/src/main/java/net/micode/notes/widget/NoteWidgetProvider_4x.java

@@ -24,7 +24,7 @@ import net.micode.notes.data.Notes;
 import net.micode.notes.tool.ResourceParser;
 
 
-public class NoteWidgetProvider_4x extends NoteWidgetProvider {
+public class NoteWidgetProvider_4x extends NoteWidgetProvider {//4倍大小的桌面挂件
     @Override
     public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
         super.update(context, appWidgetManager, appWidgetIds);