hookehuyr

docs(app.js): 为网络相关函数添加JSDoc注释

添加详细的JSDoc注释说明get_network_type、has_offline_qr_cache和handle_bad_network_on_launch函数的功能、返回值和使用场景
1 /* 1 /*
2 * @Date: 2025-06-28 10:33:00 2 * @Date: 2025-06-28 10:33:00
3 * @LastEditors: hookehuyr hookehuyr@gmail.com 3 * @LastEditors: hookehuyr hookehuyr@gmail.com
4 - * @LastEditTime: 2026-01-13 13:49:42 4 + * @LastEditTime: 2026-01-13 13:55:59
5 * @FilePath: /xyxBooking-weapp/src/app.js 5 * @FilePath: /xyxBooking-weapp/src/app.js
6 * @Description: 应用入口文件 6 * @Description: 应用入口文件
7 */ 7 */
...@@ -101,6 +101,10 @@ const App = createApp({ ...@@ -101,6 +101,10 @@ const App = createApp({
101 return ['wifi', '4g', '5g', '3g'].includes(network_type) 101 return ['wifi', '4g', '5g', '3g'].includes(network_type)
102 } 102 }
103 103
104 + /**
105 + * 获取当前网络类型
106 + * @returns {string} 当前网络类型,如 wifi、4g、5g、3g、none 等
107 + */
104 const get_network_type = async () => { 108 const get_network_type = async () => {
105 try { 109 try {
106 const result = await new Promise((resolve, reject) => { 110 const result = await new Promise((resolve, reject) => {
...@@ -115,6 +119,10 @@ const App = createApp({ ...@@ -115,6 +119,10 @@ const App = createApp({
115 } 119 }
116 } 120 }
117 121
122 + /**
123 + * 检查是否有离线预约码缓存
124 + * @returns {boolean} 如果有离线预约码缓存且有效,则返回 true;否则返回 false
125 + */
118 const has_offline_qr_cache = () => { 126 const has_offline_qr_cache = () => {
119 try { 127 try {
120 const data = Taro.getStorageSync('OFFLINE_QR_DATA') 128 const data = Taro.getStorageSync('OFFLINE_QR_DATA')
...@@ -124,7 +132,17 @@ const App = createApp({ ...@@ -124,7 +132,17 @@ const App = createApp({
124 } 132 }
125 } 133 }
126 134
135 + /**
136 + * 处理在启动时出现的不良网络情况
137 + * - 当网络连接不良且有离线预约码缓存时,提示用户是否使用缓存预约码进入离线模式
138 + * - 当网络连接不良且无离线预约码缓存时,提示用户网络连接不畅
139 + * @returns {Promise<boolean>} 如果用户选择使用缓存预约码进入离线模式,则返回 true;否则返回 false
140 + */
127 const handle_bad_network_on_launch = async () => { 141 const handle_bad_network_on_launch = async () => {
142 + /**
143 + * 避免重复提示用户
144 + * - 仅在首次启动时检查网络情况
145 + */
128 if (has_shown_network_modal) return false 146 if (has_shown_network_modal) return false
129 147
130 const network_type = await get_network_type() 148 const network_type = await get_network_type()
......