代码规范试用稿

代码规范试用稿内容摘要：

– 要站在继任者的角度写 – 简单明了、准确易懂、防止二义性 – 让继任者可以轻松阅读、复用、修改自己的代码 – 让继任者轻松辨别出哪些使自己写的，哪些是别人写的 2020/11/17 制作人 苏小红 21 注释规范  不好的注释 – i = i + 1。 //i加 1 – return 1。 //返回 1 – free(p)。 //释放 p所指的内存 – fclose(fin)。 //关闭文件 – /******************************************/ /*功能描述： 本函数用于实现 xxx功能，目的是： */ /*入口参数： 参数 p，表示指向结构体的指针 */ /*出口参数： 参数 xx，表示 */ /*返回值： 返回 xx值，当返回 xx值时，表示 */ /******************************************/ 2020/11/17 制作人 苏小红 22 注释规范  不好的注释不但白写，还扰乱了读者的视线 /*以二进制只读方式打开文件并判断打开是否成功 */ if ((fin = fopen(,rb) == NULL) { puts(打开文件 )。 /*如果打开失败，则显示错误信息 */ return 1。 /*返回 1*/ } …… /*从图像的第 1行到第 400行循环 */ for (i=0。 i400。 i++) /*从图像的第 1列到第 400列循环 */ for (j=0。 j400。 j++) {…… /*按照公式 Y = *R+*G+*B计算灰度值 */ y = (299 * r + 587 * g + 114 * b) / 1000。 …… } …… fclose(fin)。 /*关闭文件 */ 2020/11/17 制作人 苏小红 23 注释规范  好的注释（尤其是算法注释）是对设计思想的精确表述和清晰展现，能揭示代码背后隐藏的重要信息 /*打开输入文件后判断文件长度是否符合格式要求 */ if ((fin = fopen(,rb) == NULL) { puts(打开文件 )。 return 1。 } …… /* * 下面是图像转换的算法实现。 彩色图像到灰度图像的转换主要利用 RGB颜色空间到 * YUV颜色空间的变换公式来取得灰度值，公式为 Y = *R+*G+*B */ for (i=0。 i400。 i++) for (j=0。 j400。 j++) {…… y = (299 * r + 587 * g + 114 * b) / 1000。 …… } …… fclose(fin)。 2020/11/17 制作人 苏小红 24 注释规范  在哪些地方写注释。 – 在重要的文件首部  文件名 + 功能说明 + [作者 ] + [版本 ] + [版权声明 ] + [日期 ] – 在用户自定义函数前  对函数接口进行说明  函数功能 + 入口参数 +出口参数 + 返回值 （包括出错处理） – 在一些重要的语句块上方  对代码的功能、原理进行解释说明 – 在一些重要的语句行右方  定义一些非通用的变量  函数调用  较长的、多重嵌套的语句块结束处 – 在修改的代码行旁边加注释 2020/11/17 制作人 苏小红 25 注释规范  函数的注释风格 – C风格 – /**********************************************/ /*功能描述： 本函数用于实现 xxx功能，目的是： */ /*入口参数： 参数 xx，表示 */ /*出口参数： 参数 xx，表示 */ /*返回值： 返回 xx值，当返回 xx值时，表示 */ /**********************************************/ – /* 功能描述： 本函数用于实现 xxx功能，目的是： 入口参数： 参数 xx，表示 出口参数： 参数 xx，表示 返回值： 返回 xx值，当返回 xx值时，表示 */ – C++风格 – ////////////////////////////////////////// //功能描述： 本函数用于实现 xxx功能，目的是： //入口参数： 参数 xx，表示 //出口参数： 参数 xx，表示 //返回值： 返回 xx值，当返回 xx值时，表示 ////////////////////////////////////////// 2020/11/17 制作人 苏小红 26 注释规范  一块语句的注释风格 – /* *C风格 */ – C风格 – /********************************/ /*下面代码是用来接收网络数据，其原理为 */ /* …… */ /********************************/ – ////////////////////////////////// // Visual C++风格 // ////////////////////////////////// 2020/11/17 制作人 苏小红 27 注释规范  一行语句的注释风格 – /*C风格 */ – //Visual C++风格 – i = j + 1。 //代码行右方的注释 – //代码行之上的注释 i = j + 1。 – 例子  ResetSrollInfo(g_hwndThumb)。 //初始化滚动条位置  for循环 { while循环 { if() {。