sql注释

代码解读/MiNotes-master/app/src/main/java/net/micode/notes/gtask/data/MetaData.java

@@ -1,104 +1,96 @@
+/**
+
+ MetaData类是Task类的子类，表示GTask的元数据。
+ */
 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();
+    // 关联的gid
     private String mRelatedGid = null;
-    /*
-     * 功能描述：设置数据，即生成元数据库
-     * 实现过程：调用JSONObject库函数put ()，Task类中的setNotes ()和setName ()函数
-     * 参数注解：
+
+    /**
+     * 设置元数据的gid和相关信息
+     *
+     * @param gid 元数据的gid
+     * @param metaInfo 元数据的相关信息
      */
-    public void setMeta(String gid, JSONObject metaInfo)
-    {
-        //对函数块进行注释
+    public void setMeta(String gid, JSONObject metaInfo) {
         try {
+            // 将关联的gid放入JSONObject中
             metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid);
-            /*
-             * 将这对键值放入metaInfo这个jsonobject对象中
-             */
         } catch (JSONException e) {
             Log.e(TAG, "failed to put related gid");
-            /*
-             * 输出错误信息
-             */
         }
+        // 将元数据的相关信息转换为字符串，设置为Task的notes
         setNotes(metaInfo.toString());
+        // 设置Task的名称为元数据的名称
         setName(GTaskStringUtils.META_NOTE_NAME);
     }
-    /*
-     * 功能描述：获取相关联的Gid
-     */
     public String getRelatedGid() {
         return mRelatedGid;
     }
-    /*
-     * 功能描述：判断当前数据是否为空，若为空则返回真即值得保存
-     * Made By CuiCan
+
+    /**
+     * 判断元数据是否有值。
+     * @return 如果有备注信息则返回true，否则返回false。
      */
     @Override
     public boolean isWorthSaving() {
         return getNotes() != null;
     }
-    /*
-     * 功能描述：使用远程json数据对象设置元数据内容
-     * 实现过程：调用父类Task中的setContentByRemoteJSON ()函数，并
-     * 参数注解：
+
+    /**
+     * 通过远程JSON对象设置元数据内容。
+     * @param js 远程JSON对象。
      */
     @Override
     public void setContentByRemoteJSON(JSONObject js) {
         super.setContentByRemoteJSON(js);
         if (getNotes() != null) {
             try {
+                // 解析备注信息
                 JSONObject metaInfo = new JSONObject(getNotes().trim());
                 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
+
+    /**
+     * 本地JSON对象不应该调用该方法。
+     * @param js 本地JSON对象。
      */
     @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
+
+    /**
+     * 不应该被调用的方法。
+     * @return 不应该被调用的方法。
      */
     @Override
     public JSONObject getLocalJSONFromContent() {
         throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called");
-        /*
-         * 传递非法参数异常
-         * Made By Cui Can
-         */
     }
-    /*
-     * 功能描述：获取同步动作状态，一般不会用到，若用到，则抛出异常
-     * Made By CuiCan
-     */
+    /******/
+/*该方法接受一个 Cursor 参数，返回一个整型值。
+
+方法体中抛出了一个 IllegalAccessError 异常，并指定了异常消息为 "MetaData:getSyncAction should not be called"，即 "MetaData:getSyncAction 不应该被调用"。*/
     @Override
     public int getSyncAction(Cursor c) {
         throw new IllegalAccessError("MetaData:getSyncAction should not be called");
-        /*
-         * 传递非法参数异常
-         * Made By Cui Can
-         */
     }
 
 }