From 78a19b6876bb54b738d25441a7dbc1236da0d537 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=87=91=E6=88=9F?= Date: Sat, 19 Dec 2020 00:52:32 +0800 Subject: [PATCH] add feedback doc --- docs/zh-cn/doc/feedback.md | 8 ++++++++ docs/zh-cn/doc/use-mock.md | 4 ++++ docs/zh-cn/sidebar.md | 1 + 3 files changed, 13 insertions(+) create mode 100644 docs/zh-cn/doc/feedback.md diff --git a/docs/zh-cn/doc/feedback.md b/docs/zh-cn/doc/feedback.md new file mode 100644 index 0000000..1004832 --- /dev/null +++ b/docs/zh-cn/doc/feedback.md @@ -0,0 +1,8 @@ +问题反馈 +--- + +在使用`TestableMock`过程中如有任何问题或建议,请直接在[项目Issue](https://github.com/alibaba/testable-mock/issues)中提出,我们将在24小时内回复。 + +请详细描述遇到的情况,若您觉得问题可能与`TestableMock`的潜在BUG有关,请尽量提供可复现的相关源码或示例,以便进行针对性定位和排查 : ) + +`TestableMock`,让Java没有难测的代码! diff --git a/docs/zh-cn/doc/use-mock.md b/docs/zh-cn/doc/use-mock.md index ba9848f..466e723 100644 --- a/docs/zh-cn/doc/use-mock.md +++ b/docs/zh-cn/doc/use-mock.md @@ -3,6 +3,10 @@ 相比以往Mock工具以类为粒度的Mock方式,`TestableMock`允许用户直接定义需要Mock的单个方法,并遵循约定优于配置的原则,按照规则自动在测试运行时替换被测方法中的指定方法调用。 +> 归纳起来就两条: +> - Mock非构造方法,拷贝原方法定义到测试类,增加一个与调用者类型相同的参数,加`@MockMethod`注解 +> - Mock构造方法,拷贝原方法定义到测试类,返回值换成构造的类型,方法名随意,加`@MockContructor`注解 + 具体的Mock方法定义约定如下: #### 1. 覆写任意类的方法调用 diff --git a/docs/zh-cn/sidebar.md b/docs/zh-cn/sidebar.md index 9f277d6..92e8559 100644 --- a/docs/zh-cn/sidebar.md +++ b/docs/zh-cn/sidebar.md @@ -13,3 +13,4 @@ - 技术参考 - [主流Mock工具对比](zh-cn/doc/comparation.md) - [Release Note](zh-cn/doc/release-note.md) + - [问题反馈](zh-cn/doc/feedback.md)