jdw注释

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

@@ -1,54 +1,53 @@
-/*
- * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
 package net.micode.notes.gtask.data;
-
+ 
-import android.database.Cursor;
-import android.util.Log;
-
-import net.micode.notes.tool.GTaskStringUtils;
-
-import org.json.JSONException;
-import org.json.JSONObject;
-
-
 public class MetaData extends Task {
+	/*
+	 * 功能描述：得到类的简写名称存入字符串TAG中
+	 * 实现过程：调用getSimpleName ()函数
+	 */
     private final static String TAG = MetaData.class.getSimpleName();
-
     private String mRelatedGid = null;
-
+    /*
-    public void setMeta(String gid, JSONObject metaInfo) {
+     * 功能描述：设置数据，即生成元数据库
+     * 实现过程：调用JSONObject库函数put ()，Task类中的setNotes ()和setName ()函数
+     * 参数注解：
+     */
+    public void setMeta(String gid, JSONObject metaInfo) 
+    {
+    	//对函数块进行注释
         try {
             metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid);
+            /*
+             * 将这对键值放入metaInfo这个jsonobject对象中
+             */
         } catch (JSONException e) {
             Log.e(TAG, "failed to put related gid");
+            /*
+             * 输出错误信息
+             */
         }
         setNotes(metaInfo.toString());
         setName(GTaskStringUtils.META_NOTE_NAME);
     }
-
+    /*
+     * 功能描述：获取相关联的Gid
+     */
     public String getRelatedGid() {
         return mRelatedGid;
     }
-
+    /*
+     * 功能描述：判断当前数据是否为空，若为空则返回真即值得保存
+     * Made By CuiCan
+     */
     @Override
     public boolean isWorthSaving() {
         return getNotes() != null;
     }
-
+    /*
+     * 功能描述：使用远程json数据对象设置元数据内容
+     * 实现过程：调用父类Task中的setContentByRemoteJSON ()函数，并
+     * 参数注解： 
+     */
     @Override
     public void setContentByRemoteJSON(JSONObject js) {
         super.setContentByRemoteJSON(js);
@@ -58,25 +57,48 @@ public class MetaData extends Task {
                 mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID);
             } catch (JSONException e) {
                 Log.w(TAG, "failed to get related gid");
+                /*
+                 * 输出警告信息
+                 */
                 mRelatedGid = null;
             }
         }
     }
-
+    /*
+     * 功能描述：使用本地json数据对象设置元数据内容，一般不会用到，若用到，则抛出异常
+     * Made By CuiCan
+     */
     @Override
     public void setContentByLocalJSON(JSONObject js) {
         // this function should not be called
         throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called");
+        /*
+         * 传递非法参数异常
+         */
     }
-
+    /*
+     * 功能描述：从元数据内容中获取本地json对象，一般不会用到，若用到，则抛出异常
+     * Made By CuiCan
+     */
     @Override
     public JSONObject getLocalJSONFromContent() {
         throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called");
+        /*
+         * 传递非法参数异常
+         * Made By Cui Can
+         */
     }
-
+    /*
+     * 功能描述：获取同步动作状态，一般不会用到，若用到，则抛出异常
+     * Made By CuiCan
+     */
     @Override
     public int getSyncAction(Cursor c) {
         throw new IllegalAccessError("MetaData:getSyncAction should not be called");
+        /*
+         * 传递非法参数异常
+         * Made By Cui Can
+         */
     }
-
+ 
-}
+}

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

@@ -1,101 +1,90 @@
-/*
- * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
 package net.micode.notes.gtask.data;
-
+ 
 import android.database.Cursor;
-
+ 
 import org.json.JSONObject;
-
+ 
+/**
+ * 应该是同步操作的基础数据类型，定义了相关指示同步操作的常量
+ * 关键字：abstract
+ */
 public abstract class Node {
-    public static final int SYNC_ACTION_NONE = 0;
+	//定义了各种用于表征同步状态的常量
-
+    public static final int SYNC_ACTION_NONE = 0;// 本地和云端都无可更新内容（即本地和云端内容一致）
-    public static final int SYNC_ACTION_ADD_REMOTE = 1;
+    
-
+    public static final int SYNC_ACTION_ADD_REMOTE = 1;// 需要在远程云端增加内容
-    public static final int SYNC_ACTION_ADD_LOCAL = 2;
+ 
-
+    public static final int SYNC_ACTION_ADD_LOCAL = 2;// 需要在本地增加内容
-    public static final int SYNC_ACTION_DEL_REMOTE = 3;
+ 
-
+    public static final int SYNC_ACTION_DEL_REMOTE = 3;// 需要在远程云端删除内容
-    public static final int SYNC_ACTION_DEL_LOCAL = 4;
+ 
-
+    public static final int SYNC_ACTION_DEL_LOCAL = 4;// 需要在本地删除内容
-    public static final int SYNC_ACTION_UPDATE_REMOTE = 5;
+ 
-
+    public static final int SYNC_ACTION_UPDATE_REMOTE = 5;// 需要将本地内容更新到远程云端
-    public static final int SYNC_ACTION_UPDATE_LOCAL = 6;
+ 
-
+    public static final int SYNC_ACTION_UPDATE_LOCAL = 6;// 需要将远程云端内容更新到本地
-    public static final int SYNC_ACTION_UPDATE_CONFLICT = 7;
+ 
-
+    public static final int SYNC_ACTION_UPDATE_CONFLICT = 7;// 同步出现冲突
-    public static final int SYNC_ACTION_ERROR = 8;
+ 
-
+    public static final int SYNC_ACTION_ERROR = 8;// 同步出现错误
+ 
     private String mGid;
-
+ 
     private String mName;
-
+ 
-    private long mLastModified;
+    private long mLastModified;//记录最后一次修改时间
-
+ 
-    private boolean mDeleted;
+    private boolean mDeleted;//表征是否被删除
-
+ 
     public Node() {
         mGid = null;
         mName = "";
         mLastModified = 0;
         mDeleted = false;
     }
-
+ 
     public abstract JSONObject getCreateAction(int actionId);
-
+ 
     public abstract JSONObject getUpdateAction(int actionId);
-
+ 
     public abstract void setContentByRemoteJSON(JSONObject js);
-
+ 
     public abstract void setContentByLocalJSON(JSONObject js);
-
+ 
     public abstract JSONObject getLocalJSONFromContent();
-
+ 
     public abstract int getSyncAction(Cursor c);
-
+ 
     public void setGid(String gid) {
         this.mGid = gid;
     }
-
+ 
     public void setName(String name) {
         this.mName = name;
     }
-
+ 
     public void setLastModified(long lastModified) {
         this.mLastModified = lastModified;
     }
-
+ 
     public void setDeleted(boolean deleted) {
         this.mDeleted = deleted;
     }
-
+ 
     public String getGid() {
         return this.mGid;
     }
-
+ 
     public String getName() {
         return this.mName;
     }
-
+ 
     public long getLastModified() {
         return this.mLastModified;
     }
-
+ 
     public boolean getDeleted() {
         return this.mDeleted;
     }
-
+ 
-}
+}