1、對於C/C++的文件,文件頭應該有類似這樣的註釋: /************************************************************************ * * 文 件 名:network.c * * 文件描述:網路通訊函數集 * * 創 建 人:H ...
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、