From 474d3176f971566d2c426bd53e7b9dcd70a352ae Mon Sep 17 00:00:00 2001 From: ruanyf Date: Tue, 2 Nov 2021 10:47:55 +0800 Subject: [PATCH] docs(lib/assert.h): fixed assert() --- docs/lib/assert.h.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/lib/assert.h.md b/docs/lib/assert.h.md index a92a548..e850971 100644 --- a/docs/lib/assert.h.md +++ b/docs/lib/assert.h.md @@ -2,15 +2,15 @@ ## assert() -`assert.h`头文件定义了宏`assert()`，用于在运行时确保程序符合指定条件，如果不符合，就报错终止运行。 +`assert.h`头文件定义了宏`assert()`，用于在运行时确保程序符合指定条件，如果不符合，就报错终止运行。这个宏常常被称为“断言”。 ```c assert(PI > 3); ``` -上面代码在程序运行到这一行语句时，验证变量是否`PI`大于3。如果确实大于3，程序继续运行，否则就会终止运行，并且给出报错信息提示。 +上面代码在程序运行到这一行语句时，验证变量`PI`是否大于3。如果确实大于3，程序继续运行，否则就会终止运行，并且给出报错信息提示。 -`assert()`宏接受一个表达式作为参数，如果表达式的返回值非零，`assert()`就会报错，在标准错误流`stderr`中写入一条错误信息，显示没有通过的表达式，以及包含这个表达式的文件名和行号。最后，调用`abort()`函数终止程序（`abort()`函数的原型在`stdlib.h`头文件中）。 +`assert()`宏接受一个表达式作为参数。如果该表达式为真（返回值非零），`assert()`不会产生任何作用，程序继续运行。如果该表达式为假（返回值为零），`assert()`就会报错，在标准错误流`stderr`中写入一条错误信息，显示没有通过的表达式，以及包含这个表达式的文件名和行号。最后，调用`abort()`函数终止程序（`abort()`函数的原型在`stdlib.h`头文件中）。 ```c z = x * x - y * y; @@ -40,16 +40,16 @@ Assertion failed: [expression], function [abc], file [xyz], line [nnn]. 上面代码中，方括号的部分使用实际数据替换掉。 -使用 assert() 有几个好处：它不仅能自动标识文件和出问题的行号，还有一种无需更改代码就能开启或关闭 assert() 的机制。如果已经确认程序没有问题，不需要再做断言，就在`#include `语句的前面，定义一个宏`NDEBUG`。 +使用`assert()`有几个好处：它不仅能自动标识文件和出问题的行号，还有一种无需更改代码就能开启或关闭`assert()`的机制。如果已经确认程序没有问题，不需要再做断言，就在`#include `语句的前面，定义一个宏`NDEBUG`。 ```c #define NDEBUG #include ``` -然后，重新编译程序，编译器就会禁用文件中所有的 assert() 语句。如果程序又出现问题，可以移除这条`#define NDBUG`指令（或者把它注释掉），再次编译，这样就重新启用了 assert() 语句。 +然后，重新编译程序，编译器就会禁用文件中所有的`assert()`语句。如果程序又出现问题，可以移除这条`#define NDBUG`指令（或者把它注释掉），再次编译，这样就重新启用了`assert()`语句。 -assert() 的缺点是，因为引入了额外的检查，增加了程序的运行时间。 +`assert()`的缺点是，因为引入了额外的检查，增加了程序的运行时间。 ## static_assert()