MetaData注释

src/net/micode/notes/gtask/data/MetaData.java

@@ -26,29 +26,60 @@ import org.json.JSONObject;
 
 
 public class MetaData extends Task {
+
+	/*
+	 * 功能描述：得到类的简写名称存入字符串TAG中
+	 * 实现过程：调用getSimpleName ()函数
+	 */
     private final static String TAG = MetaData.class.getSimpleName();
 
     private String mRelatedGid = null;
 
+    /*
+     * 功能描述：设置数据，即生成元数据库
+     * 实现过程：调用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 +89,41 @@ 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
+         */
     }
 
     @Override
     public int getSyncAction(Cursor c) {
         throw new IllegalAccessError("MetaData:getSyncAction should not be called");
     }
-
+    /*
+     * 传递非法参数异常
+     * Made By Cui Can
+     */
 }