1、对于C/C++的文件,文件头应该有类似这样的注释:
/************************************************************************
*
* 文件名:network.c
*
* 文件描述:网络通讯函数集
*
* 创建人:Hao Chen, 2003年2月3日
*
* 版本号:1.0
*
************************************************************************/
2、而对于函数来说,应该也有类似于这样的注释:
/*================================================================
*
* 函 数 名:XXX
*
* 参 数:type name [IN] : descripts
*
* 功能描述:
*
* 返 回 值:成功TRUE,失败FALSE
*
* 作 者:ChenHao 2003/4/2
*
================================================================*/
3、
德高培身,财多伤身。