From 00290e3820a42335d5dc10674719565f5f47b5cf Mon Sep 17 00:00:00 2001 From: Sutra Zhou Date: Wed, 23 May 2018 00:21:01 +0800 Subject: [PATCH] Revise javadoc. --- .../foxinmy/weixin4j/wxa/api/QrCodeApi.java | 31 ++++++++++--------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/QrCodeApi.java b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/QrCodeApi.java index e02c38bd..4f0890a4 100644 --- a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/QrCodeApi.java +++ b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/QrCodeApi.java @@ -36,13 +36,14 @@ public class QrCodeApi extends WxaApi { * 注意：通过该接口生成的小程序码，永久有效，数量限制见微信小程序文档文末说明，请谨慎使用。 * 用户扫描该码进入小程序后，将直接进入 path 对应的页面。 *

+ * * @param path 不能为空，最大长度 128 字节 * @param width 二维码的宽度，默认值 430 * @param autoColor 自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调 * @param lineColor authColor 为 false 时生效 * @param hyaline 是否需要透明底色， 为true时，生成透明底色的小程序码 * @return image bytes of WXA code. - * @throws WeixinException indicates get access token failed or get WXA code failed. + * @throws WeixinException indicates getting access token failed or getting WXA code failed. * * @see 获取小程序码 */ @@ -68,17 +69,18 @@ public class QrCodeApi extends WxaApi { * 用户扫描该码进入小程序后，开发者需在对应页面获取的码中 scene 字段的值，再做处理逻辑。 * 使用如下代码可以获取到二维码中的 scene 字段的值。 * 调试阶段可以使用开发工具的条件编译自定义参数 scene=xxxx 进行模拟， - * 开发工具模拟时的 scene 的参数值需要进行 urlencode - * - * // 这是首页的 js - * Page({ - * onLoad: function(options) { - * // options 中的 scene 需要使用 decodeURIComponent 才能获取到生成二维码时传入的 scene - * var scene = decodeURIComponent(options.scene) - * } - * }) - * - *

+ * 开发工具模拟时的 scene 的参数值需要进行 urlencode。 + *

+ * 

+	 * // 这是首页的 js
+	 * Page({
+	 *   onLoad: function(options) {
+	 *     // options 中的 scene 需要使用 decodeURIComponent 才能获取到生成二维码时传入的 scene
+	 *     var scene = decodeURIComponent(options.scene)
+	 *   }
+	 * })
+	 *
+ * * @param scene 最大32个可见字符，只支持数字， * 大小写英文以及部分特殊字符：!#$&'()*+,/:;=?@-._~， * 其它字符请自行编码为合法字符（因不支持%，中文无法使用 urlencode 处理，请使用其他编码方式） @@ -91,7 +93,7 @@ public class QrCodeApi extends WxaApi { * @param lineColor autoColor 为 false 时生效，使用 rgb 设置颜色 * @param hyaline 是否需要透明底色，为true时，生成透明底色的小程序码 * @return image bytes of WXA code. - * @throws WeixinException indicates get access token failed or get WXA code failed. + * @throws WeixinException indicates getting access token failed or getting WXA code failed. * * @see 获取小程序码 */ @@ -117,10 +119,11 @@ public class QrCodeApi extends WxaApi { * 注意：通过该接口生成的小程序二维码，永久有效，数量限制见微信小程序文档文末说明，请谨慎使用。 * 用户扫描该码进入小程序后，将直接进入 path 对应的页面。 *

+ * * @param path 不能为空，最大长度 128 字节 * @param width 二维码的宽度，默认值 430 * @return image bytes of WXA QR code. - * @throws WeixinException indicates get access token failed or get WXA QR code failed. + * @throws WeixinException indicates getting access token failed or getting WXA QR code failed. * * @see 获取小程序二维码 */