add feedback doc

2025-01-24 03:10:14 +08:00 · 2020-12-19 00:52:32 +08:00 · 2020-12-19 00:52:32 +08:00 · 78a19b6876
commit 78a19b6876
parent 5484b216f1
3 changed files with 13 additions and 0 deletions
--- a/docs/zh-cn/doc/feedback.md
+++ 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没有难测的代码！
--- 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. 覆写任意类的方法调用
--- 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)