01-软件编码和命名规范解答.docVIP

第三届中国大学生服务外包创新应用大赛 盐城师范学院参赛团队(ITGroup) 下位机软件编码和命名规范 2012.7 文档修订记录 版本 完成人 修改内容 审核 批准 时间 V1.0 徐裕峰 创建文档 全体 2012-6-3 1注释常用标签说明 @author 表示作者信息 @brief 用于function的批注中，后面为function的简易说明。 @param 格式为 @param [in,intout,out] arg_name -参数说明 主要用于函数说明中，后面接参数的名字，然后再接关于该参数的说明。 @return 后面接函数传回值的说明。用于function的批注中。说明该函数的传回值。 @Revision 用于说明文件版本号 @ Revised 用于说明修改内容、时间和修改者 格式为 20xx.x.x(XXX对XXXX进行修改) 2 注释规范 2.1注释原则 有助于对程序的阅读理解,说明程序在做什么,解释代码的目的、功能和采用的方法。 一般情况源程序有效注释量在%左右。注释语言必须准确、易懂、简洁。边写代码边注释,修改代码同时修改相应的注释,不再有用的注释要删除。 文件注释必须说明文件名、函数功能、创建