ASSERT用法

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)
 {

6)让assert嵌入更多的信息

void VectorNormalize(Vec* src, Vec* dst)
{
 float length;
 assert(src!=0 && "VectorNormalize: src vector pointer is Null");
 assert(dst!=0 && "VectorNormalize: dst vector pointer is Null");

 ...................
 ...................
}

有了这个直观的字符串提示，就可以告诉当前的函数名，错误原因。

一个完整的例子
:

如:
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;
}