函数注释参考,好的函数注释对于代码的维护以及后来人观看时及其重要,一个好的注释可以让开发和维护变得更简单高效。
/***********************************************************************
*@函数名称: 函数的名字
*@功能描述: read data from ctpm by i2c interface;
*@参数:
buffer[in]: databuffer;
length[in]: thelength of the data buffer;
*@返回:
FTS_TRUE: success;
FTS_FALSE: fail;
*@备注:
**********************************************************************/