增加更多的测试用例；更新文档

Author: du-yicheng23

README.md

@@ -1,6 +1,7 @@
 # rmdev_test_framework
 
-一个纯 C 语言，适用于单片机开发的简易测试框架。也是 [rmdev](https://github.com/CQUT-RoboMaster-ShiJi-DREAMER-ECU-Team/rmdev)
+一个纯 C
+语言，适用于单片机开发的简易测试框架。也是 [rmdev](https://github.com/CQUT-RoboMaster-ShiJi-DREAMER-ECU-Team/rmdev)
 的一个子项目。
 
 ## 使用方法
@@ -26,8 +27,4 @@ CMake 3.5 或更高版本。
 ### 使用步骤
 
 1. 将 `rmdev_test_framework.h` 头文件包含到主函数所在的文件中。
-2. 在测试代码的主函数中调用 `rmdev_test_framework_main()` 函数。
-3. 实现相关接口函数（在合适的位置定义函数）：
-   1. `void rmdev_test_Printf(const char* format, ...)` - 用于格式化输出测试结果。
-   2. `void rmdev_test_Delay(const unsigned int ms)` - 用于延时。
-4. 定义测试项函数 `void rmdev_test_testItem(void)`，在这个函数内调用测试宏。
+2. 在测试代码的主函数中调用 `rmdev_test_framework_main()` 函数。相关参数可参考阅读函数的注释。

inc/rmdev_test_framework.h

@@ -40,14 +40,29 @@ typedef void (*rmdev_test_testItemCallback)(void);
 /**
  * rmdev 测试框架 主函数
  * @attention 需要将其放在真正的 main 函数中调用
+ * @param break_char 换行符
+ * @param printfCallback 用于格式化输出的回调函数
+ * @param delayCallback 用于延时的回调函数
+ * @param testItemCallback 运行测试项的回调函数（你执行的测试在这个函数里执行）
  */
 void rmdev_test_framework_main(const char* break_char,
                                rmdev_test_printfCallback printfCallback,
                                rmdev_test_delayCallback delayCallback,
                                rmdev_test_testItemCallback testItemCallback);
 
+/**
+ * rmdev 测试框架 定义一个测试项
+ * @attention 不建议直接调用这个函数，而是使用宏 RMDEV_TEST_ITEM，因为这个宏可以自动填写文件名与行号
+ * @param name 测试项名称
+ * @param file 调用函数所在的文件名
+ * @param line 调用函数所在的行号
+ */
 void rmdev_test_item(const char* name, const char* file, int line);
 
+/**
+ * rmdev 测试框架 定义一个测试项
+ * @param name 测试项名称
+ */
 #define RMDEV_TEST_ITEM(name) rmdev_test_item(name, __FILE__, __LINE__)
 
 /**
@@ -67,7 +82,7 @@ void rmdev_test_check(const char* file, int line, rmdev_test_bool_t result);
 
 /**
  * rmdev 测试框架 断言布尔表达式是否正确（测试失败后会停止测试）
- * @attention 不建议直接调用这个函数，而是使用宏 RMDEV_TEST_CHECK，因为这个宏可以自动填写文件名与行号
+ * @attention 不建议直接调用这个函数，而是使用宏 RMDEV_TEST_ASSERT，因为这个宏可以自动填写文件名与行号
  * @param file 调用函数所在的文件名
  * @param line 调用函数所在的行号
  * @param result 待检查的布尔表达式

src/rmdev_test_framework.c

@@ -51,6 +51,10 @@ static void rmdev_test_item_finish(const char* name);
     do {               \
     } while (RMDEV_TEST_TRUE)
 
+/**
+ * 测试项结束
+ * @param name 结束的测试项的名称
+ */
 static void rmdev_test_item_finish(const char* name)
 {
     in_test_item = RMDEV_TEST_FALSE;

test/main.c

@@ -11,7 +11,7 @@
 
 #include "test_function_impl.h"
 
-void my_testItem(void)
+void testUsage(void)
 {
     RMDEV_TEST_ITEM("Constant Test");
     RMDEV_TEST_CHECK(true);
@@ -22,6 +22,23 @@ void my_testItem(void)
     RMDEV_TEST_CHECK((2 * 2) == 4);
     RMDEV_TEST_CHECK((3 - 1) == 2);
 
+    RMDEV_TEST_CHECK((10 / 2) == 5);
+    RMDEV_TEST_CHECK((5 % 2) == 1);
+    RMDEV_TEST_CHECK((7 * 3) == 21);
+    RMDEV_TEST_CHECK((8 - 3) == 5);
+    RMDEV_TEST_CHECK((4 + 6) == 10);
+
+    RMDEV_TEST_CHECK((10 / 3) == 4);  // false
+
+    RMDEV_TEST_ASSERT((15 / 3) == 5);
+    RMDEV_TEST_ASSERT((9 % 3) == 0);
+    RMDEV_TEST_ASSERT((6 * 6) == 36);
+
+    RMDEV_TEST_CHECK((2 * 2) == 5);  // false
+
+    RMDEV_TEST_ASSERT((20 - 10) == 10);
+    RMDEV_TEST_ASSERT((3 + 7) == 10);
+
     RMDEV_TEST_CHECK((1 + 1) == 3);  // false
 
     RMDEV_TEST_CHECK((114514 + 1919810) == 2034324);
@@ -36,7 +53,8 @@ void my_testItem(void)
 
 int main(void)
 {
-    rmdev_test_framework_main("\n", my_printf, my_delay, my_testItem);
+    // todo 待增加其他的测试（比如传入空指针）
+    rmdev_test_framework_main("\n", my_printf, my_delay, testUsage);
 
     return 0;
 }