首页 > 代码库 > 3 注释规范和命名规则
3 注释规范和命名规则
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、
3 注释规范和命名规则
声明:以上内容来自用户投稿及互联网公开渠道收集整理发布,本网站不拥有所有权,未作人工编辑处理,也不承担相关法律责任,若内容有误或涉及侵权可进行投诉: 投诉/举报 工作人员会在5个工作日内联系你,一经查实,本站将立刻删除涉嫌侵权内容。