ADS环境下的ASSERT的用法介绍

xtss

ADS环境下的ASSERT的用法介绍 [复制链接]

ASSERT()是一个调试程序时经常使用的宏，在程序运行时它计算括号内的表达式，如果表达式为FALSE (0), 程序将报告错误，并终止执行。如果表达式不为0，则继续执行后面的语句。这个宏通常原来判断程序中是否出现了明显非法的数据，如果出现了终止程序以免导致严重后果，同时也便于查找错误。例如，变量n在程序中不应该为0，如果为0可能导致错误，你可以这样写程序：
    ......
    ASSERT( n != 0);
    k = 10/ n;
    ......
    ASSERT只有在Debug版本中才有效，如果编译为Release版本则被忽略。
    assert()的功能类似，它是ANSI C标准中规定的函数，它与ASSERT的一个重要区别是可以用在Release版本中。
    这是个定义在 中的宏, 用来测试断言。一个断言本质上是写下程序员的假设, 如果假设被违反, 那表明有个严重的程序错误。例如, 一个假设只接受非空指针的函数, 可以写:
    assert(p != NULL);

一个失败的断言会中断程序。断言不应该用来捕捉意料中的错误, 例如  malloc() 或 fopen() 的失败



ASSERT用法
1)在函数开始处检验传入参数的合法性
如:

int CBufferPool::ResetBufferSize(int nNewSize)
{
//功能:改变缓冲区大小,
//参数:nNewSize 缓冲区新长度
//返回值:缓冲区当前长度
//说明:保持原信息内容不变  nNewSize<=0表示清除缓冲区
ASSERT(nNewSize >= 0);
ASSERT(nNewSize <= MAX_BUFFER_SIZE);

...
}


2)每个ASSERT只检验一个条件,因为同时检验多个条件时,如果断言失败,无法直观的判断是哪个条件失败
不好: ASSERT(nOffset>=0 && nOffset+nSize<=m_nInfomationSize);

好: ASSERT(nOffset >= 0);
ASSERT(nOffset+nSize <= m_nInfomationSize);

3)不能使用改变环境的语句,因为ASSERT只在DEBUG个生效,如果这么做,会使用程序在真正运行时遇到问题

错误: ASSERT(i++ < 100)

正确: ASSERT(i < 100)
      i++;

4)ASSERT和后面的语句应空一行,以形成逻辑和视觉上的一致感
5)有的地方,ASSERT不能代替条件过滤

如:
int CDecodeBuffer::GetIntValue(int nOffset, int nSize) const
{
//功能:取出缓冲区中的一个有符号整数
//参数:nOffset   开始位置
//     nSize     字节数
//返回值:  如可在法位置返回正常值 否则为INVALID_VALUE
//建立日期:2005-09-12

ASSERT(nOffset >= 0);
ASSERT(nOffset+nSize <= m_nInfomationSize);

int nReturnValue = INVALID_VALUE;
if (nOffset>=0 && nOffset+nSize<=m_nInfomationSize)
{


一个完整的例子
:
如:
BYTE CDecodeBuffer::GetBit(int nByteStart, int nBitOffset) const
{
//取缓冲区中的一个位
// nByteStart  开始字节
ASSERT(nByteStart >= 0);
ASSERT(nBitOffset >= 0);

BYTE nReturn=0;
nBitOffset = nByteStart*8+nBitOffset;
ASSERT((nBitOffset+7)/8 <= m_nInfomationSize);
if (nBitOffset>=0 && (nBitOffset+7)/8<=m_nInfomationSize)
{
  nReturn = GET_BIT(m_pBufferHead[nBitOffset/8],nBitOffset%8);
}
return nReturn;
}