【代码评审】IoT：设备配置的评审

Author: YunaiV

src/views/iot/device/device/detail/DeviceDetailConfig.vue

@@ -1,13 +1,15 @@
+<!-- 设备配置 -->
 <template>
   <div>
     <el-alert
-      title="IoT平台支持远程更新设备的配置文件(SON格式)，您可以在下方编辑配置模板，对设备的系统参数、网络参数等进行远程配置，通过批量更新对设备进行批量远程维护和管理。"
+      title="支持远程更新设备的配置文件(JSON 格式)，可以在下方编辑配置模板，对设备的系统参数、网络参数等进行远程配置。配置完成后，需点击「下发」按钮，设备即可进行远程配置。"
       type="info"
       show-icon
       class="my-4"
       description="如需编辑文件，请点击下方编辑按钮"
     />
-    
+
+    <!-- JSON 编辑器：读模式 -->
     <Vue3Jsoneditor
       ref="editor"
       v-if="isEditing"
@@ -17,6 +19,7 @@
       currentMode="code"
       @error="onError"
     />
+    <!-- JSON 编辑器：写模式 -->
     <Vue3Jsoneditor
       ref="editor"
       v-else
@@ -35,53 +38,49 @@
 </template>
 
 <script lang="ts" setup>
-import { ref, computed } from 'vue';
-import Vue3Jsoneditor from 'v3-jsoneditor/src/Vue3Jsoneditor.vue';
+import { ref, computed } from 'vue'
+import Vue3Jsoneditor from 'v3-jsoneditor/src/Vue3Jsoneditor.vue'
 
-// 定义设备配置的状态
 const deviceConfig = ref({
-  "name": "dyla1n"
-});
-
-// 编辑状态
-const isEditing = ref(false);
-
-// JSON 编辑器的选项
+  name: 'dyla1n'
+}) // 定义设备配置 TODO @dylan：从后端读取
+const isEditing = ref(false) // 编辑状态
 const editorOptions = computed(() => ({
   mainMenuBar: false,
   navigationBar: false,
-  statusBar: false,
-}));
+  statusBar: false
+})) // JSON 编辑器的选项
 
-// 启用编辑模式的函数
+/** 启用编辑模式的函数 */
 const enableEdit = () => {
-  isEditing.value = true;
-};
+  isEditing.value = true
+}
 
-// 取消编辑的函数
+/** 取消编辑的函数 */
 const cancelEdit = () => {
-  isEditing.value = false;
+  isEditing.value = false
   // 逻辑代码
-  console.log('取消编辑');
-};
+  console.log('取消编辑')
+}
 
-// 保存配置的函数
+/** 保存配置的函数 */
 const saveConfig = () => {
-  isEditing.value = false;
+  isEditing.value = false
   // 逻辑代码
-  console.log('保存配置');
-};
+  console.log('保存配置')
+}
 
-// 处理 JSON 编辑器错误的函数
+/** 处理 JSON 编辑器错误的函数 */
 const onError = (e: any) => {
-  console.log('onError', e);
-};
+  console.log('onError', e)
+}
 </script>
 
+<!-- TODO dylan：建议使用 unocss 替代哈，AI 模型友好 -->
 <style scoped>
 .button-group {
   display: flex;
   justify-content: center;
   margin-top: 20px;
 }
-</style>
+</style>