软件编程规范

[复制链接]
1685|26
ah9b87 发表于 2016-3-25 22:21 | 显示全部楼层
函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。
示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内
ah9b87 发表于 2016-3-25 22:21 | 显示全部楼层
/*************************************************
Function: // 函数名称
Description: // 函数功能、性能等的描述
Calls: // 被本函数调用的函数清单
Called By: // 调用本函数的函数清单
Table Accessed: // 被访问的表(此项仅对于牵扯到数据库操作的程序)
Table Updated: // 被修改的表(此项仅对于牵扯到数据库操作的程序)
Input: // 输入参数说明,包括每个参数的作
// 用、取值说明及参数间关系。
Output: // 对输出参数的说明。
Return: // 函数返回值的说明
Others: // 其它说明
*************************************************/
ah9b87 发表于 2016-3-25 22:22 | 显示全部楼层
边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。
huihui520 发表于 2016-3-25 22:23 | 显示全部楼层
注释的内容要清楚、明了,含义准确,防止注释二义性。说明:错误的注释不但无益反而有害。
ah9b87 发表于 2016-3-25 22:23 | 显示全部楼层
规则2-7:避免在注释中使用缩写,特别是非常用缩写。说明:在使用缩写时或之前,应对缩写进行必要的说明。
huihui520 发表于 2016-3-25 22:23 | 显示全部楼层
规则2-7:避免在注释中使用缩写,特别是非常用缩写。说明:在使用缩写时或之前,应对缩写进行必要的说明。
ah9b87 发表于 2016-3-25 22:25 | 显示全部楼层
注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开
您需要登录后才可以回帖 登录 | 注册

本版积分规则

快速回复 在线客服 返回列表 返回顶部