代码走查该走查什么

2023-11-02

代码走查在很多公司都是一个必要的过程,但是很多时候却时候一个形同虚设的过程,通常检查的同事只要保证你的代码能够编译通过,不出现问题就pass了。到底代码走查有没有一定的规范性呢?

如果公司是严格按照开发流程来的话,那么代码走查可能也会是下图中红色,它标示着代码走查可以使得设计人员和开发人员之间识别出错误,防止出现设计一套方案开发又开发自己又写出了另一套方案的问题发生。这在一些业务性比较强的系统中代码走查尤为重要,如果开发人员因为业务不熟导致理解错误那么出现的问题也能就会不可预估了,这个时候的代码走查就可以及早发现问题,也是一个开发人员向其他人员阐述自己所理解的业务信息的一个渠道。

大部分的公司代码走查是在同事之间互查,通常我们会遇到这样开头说的情况,只是保证编译通过或者没有一个详细的步骤来执行这个步骤。本文的重点也将放在这里,讨论如何进行这种情况下C++的代码走查。我觉得可以将代码审查从大到细分为几个步骤,只要按照这样的流程下来,基本上可以过滤掉大部分不需要犯的错误。

 

 

²文档审查

1        文档时候有说明信息,写明文件的主要作用类信息,文件名等

2        头文件是否只用宏定义防止重复引用

Exp:         #ifndef_A_HH_

                   #define_A_HH_

                   ………//class info

                #endif //_A_HH_

3        函数声明时候有明确的返回值

Exp:默认情况下编译器会提为什么返回值的函数设置为返回类型为int ,这种情况下很难判断要返回是数据类型。很有可能是手误操作导致。

²函数审查

1        函数声明时候得当,好的函数什么使得调用者和后期维护都将受用

2        入参个数合理性检查,一般不要超过6个,超过的可以考虑用结构体。

参数多了函数调用效率就将下来了。在如下这些情况下传送指针作为参数是更好的选择:

     1需要传送大量的数据和大型的数据结构作为输入

     2被调函数需要修改调用函数的数据

3        入参合法性检查(空指针,取值范围,内存越界),

Exp

         1.NULL  == param

         2.如果带了一个buf最好跟一个参数表明buf的长度。

…..

²变量审查

1        是否初始化

2        是否存在类型不匹配的比较操作(尤其是unsigned 类型和 signed类型的比较)对于unsigned 类型注意边界判断。

3        是否定义了变量但是没有使用

²内存资源审查

1        是否对数组进行了越界操作。

2        内存拷贝时是否判断了长度。Strcpy的时候要注意dst 要比src 内存大,否则导致内存越界

3        申请内存后是否判断了内存申请成功。

Exp:char p=new char[100];

          If( NULL == p )

         {

                   Return;

         }

4        对异常情况的处理时是否直接return而忘记了释放内存,尤其在一些抛出异常的时候有没有注意在catch的时候释放资源。

5        文件句柄的释放。Open对应close。

²语句规范性检查

1        { } 是否独占一行(习惯问题。。)。

Exp:

         If()

         {

                 。。。。

         }

         Else

         {

                  。。。

         }

2        一行是否只定义一个变量。

3        内存开辟malloc 和free 对应;new 和delete对应.

4        是否将 == 写错了 =。

建议做判断将常量放在前面可防止这类错误

这里只列举了本人认为相对比较重要的一些点,其他的细节就不多介绍了。。。睡觉啦,明天还得上班

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

代码走查该走查什么 的相关文章

  • 在 C++ 中迭代连续枚举值的最简单方法[重复]

    这个问题在这里已经有答案了 什么是首选simple在 C 中迭代具有连续值的枚举的方法 我发现以前关于这个主题的问题涉及创建自定义operator 等等 但这似乎有点矫枉过正 到目前为止 我想出的最好的办法是 enum FOO BAR BL
  • crt0 是否加载 msvcrt.dll?

    我想弄清楚标准 C 函数是什么样的printf 在 Windows 环境下加载到内存中 我知道crt0 obj准备堆栈 调用int main int argc char argv 然后使用 main 返回的退出代码退出进程 我还听说 C 标
  • 如何获取列表框中项目的索引?

    我正在将项目添加到ListBox像这样 myListBox Items addRange myObjectArray 我还想通过以下方式选择我添加的一些项目 foreach MyObject m in otherListOfMyObject
  • 在 Silverlight 中同步操作

    我有一个 Silverlight 应用程序 它使用操作从模型获取数据 再次从 WCF 服务获取数据 我需要以某种方式同步两个 ActionCallback 或等待它们 然后执行一些代码 Example model GetMyTypeList
  • 为什么单击 ToolStrip 按钮两次时会引发 NullReferenceException - openFileDialog.showDialog()?

    我创建了一个干净的 Windows 窗体应用程序解决方案 添加了ToolStrip到主窗体 并在其上放置一个按钮 我还添加了一个OpenFileDialog 所以这样Click event of the ToolStripButton看起来
  • 将二进制文件内容读取到 std::string 的最佳方法是什么? [复制]

    这个问题在这里已经有答案了 可能的重复 如何将 istream 与字符串一起使用 https stackoverflow com questions 6510923 how to use istream with strings std i
  • 更改 ASP.NET 控件的访问修饰符

    如果我像这样将控件放入 aspx 文件中
  • 将模型和订阅密钥传递给 LuisDialog,而不是通过属性

    我正在编写一个可以说两种语言的机器人 因此 我需要使用两个单独的 LUIS 应用程序 每种语言一个 Bot Framework 中的 LuisDialog 是这样初始化的 来自 Microsoft 的示例 LuisModel c413b2e
  • 使用日期时间作为文件名并随后解析文件名?

    我正在将文件写入硬盘 文件名是这样构建的 String Format 0 yyyy MM dd hh mm ss txt DateTime Now 例如 文件名是 2010 09 20 09 47 04 txt 现在我想在下拉列表中显示这些
  • JsonSerializer.Deserialize 失败

    考虑代码 using System using System Text Json public class Program public static void Main int id 9 string str id id var u Js
  • UWP 关闭信息亭模式

    我有一个发布到 Windows 应用商店的 UWP 应用程序 并且该应用程序可以启动进入信息亭模式 分配访问权限 它工作得很好 但我尝试在应用程序上创建一个按钮来关闭信息亭模式并返回到 Windows 登录屏幕 我尝试了文档中给出的代码 h
  • 按下按钮时更改几何绘图画笔的颜色

    我创建了一个按钮模板 有一个图像和一个标签 图像的来源位于 ResourceDictionary Pictures 中 图片的来源是具有白色画笔颜色的 DrawingImage
  • Lambda 通过引用捕获右值引用

    下面的代码标准正确吗 godbolt https godbolt org z VE0NWz IE by ref 捕获表示临时的转发引用 并从函数返回结果 lambda 按值 在同一个表达式中 当然 存储 lambda 供以后使用会使其包含悬
  • OpenMP while 循环中的手动同步

    我最近开始使用 OpenMP 为大学的一个项目做一些 研究 我有一个矩形且均匀分布的网格 在该网格上我使用迭代方案求解偏微分方程 因此 我基本上有两个 for 循环 网格的 x 方向和 y 方向各一个 并由 while 循环包裹以进行迭代
  • 为什么转发引用与右值引用具有相同的语法?

    我刚刚对这些 相当 新的功能做了一些研究 我想知道为什么 C 委员会决定为它们引入相同的语法 看来开发人员不必要浪费一些时间来理解它是如何工作的 而一种解决方案可以让我们思考进一步的问题 就我而言 它是从问题开始的 可以简化为 includ
  • 在 C++ 中的 Switch-Case 中执行 OR 运算

    你会如何在 C 中做到这一点 例如 如果用户按 ESC 或 q 或 Q 我试图触发程序退出 我尝试寻找它 但在 C 中没有找到它的语法 我知道如何使用 if else 来做到这一点 但是可以使用 switch case 来做到这一点吗 当然
  • 如何在 C# 中按进程获取打开文件句柄的列表?

    如何在 C 中通过进程 ID 获取打开文件句柄的列表 我也有兴趣挖掘并获取文件名 寻找与流程资源管理器所做的等效的编程 这很可能需要互操作 考虑到对此添加赏金 实现起来非常复杂 哎呀 这很难从托管代码中做到 有一个 大多数事情都可以在互操作
  • 单击 GridView 查找选定行

    我正在尝试获取 GridView 并从单击的行中获取数据 我已经尝试了下面的代码 当我单击该行时 我会返回选定的索引 但是当我查看 GridView 中的实际行时 它们显示为空 不知道我错过了什么 ASP 使我的网格
  • Outlook 插件:从选定的日历中获取元素

    我正在创建 Outlook 加载项 我想知道如何从选定的日历中获取元素 例如 我需要从名为 myCalendar 的日历中获取所有约会项目 现在 我可以从所有日历中获取所有约会项目 谢谢你 这些额外的日历作为主日历文件夹的子文件夹提供 所以
  • 在 '*' 标记之前编译“错误:预期 ')' 时出现多个相同错误

    我正在尝试用 C 语言编程 当我使用以下参数进行编译时 gcc D BSD SOURCE Wall ansi pedantic g tokenizer c FileOccur c WordList c wordstat c indexer

随机推荐

  • java web开发一个帐号同一时间只能一个人登录

    一个帐号同一时间只能一个人登录 对于一个帐号在同一时间只能一个人登录 可以通过下面的方法实现 1 在用户登录时 把用户添加到一个ArrayList中 2 再次登录时查看ArrayList中有没有该用户 如果ArrayList中已经存在该用户
  • springboot实现各种参数校验

    springboot实现各种参数校验 简单使用 Java API规范 JSR303 定义了Bean校验的标准validation api 但没有提供实现 hibernate validation是对这个规范的实现 并增加了校验注解如 Ema
  • 【JavaWeb】JSP使用Session、Cookie实现购物车

    购物界面shop jsp 初始页面 添加商品后 在session中设置属性 重定向回到shop jsp 然后根据session的内容显示结果 Cookie设置setMaxAge可以延长session的寿命 清空购物车就是清除session
  • 基于以太坊的USDT(基于ERC-20协议发行)

    这种USDT存储在以太坊地址上 相对应的 每次转账 链上转账 时 需要消耗Gas 也就是ETH 目前 市场上的USDT绝大部分是基于比特币的USDT 基于以太坊的USDT份额很低 约3 基于TRON网络TRC20协议的USDT 存储在TRO
  • 当心互联网抢了你的饭碗

    两年前 供职于帕洛阿尔托研究中心 Palo Alto Research Center 的学者布莱恩 亚瑟 Brian Arthur 做出了一项惊人预测 未来二三十年 西方数字网络履行的功能最终将相当于美国 实体 经济的规模 亚瑟写道 或者
  • Qt 信号和槽学习

    使用一个按钮按下时 我们可能想要窗口的 close 函数被调用 这个操作可以通过设置回调函数实现 但回调函数不够直观 而且容易出现参数类型错误等问题 Qt中使用的代替方案是信号和槽机制 信号和槽 当特定的事件出现时 一个信号被发出 槽函数作
  • 探索Java8——Lambda方法引用

    管中窥豹 方法引用让你可以重复使用现有的方法定义 并像Lambda一样传递它们 在一些情况下 比起使用Lambda表达式 它们似乎更易读 感觉也更自然 inventory sort Apple a1 Apple a2 gt a1 getWe
  • 数字孪生万亿市场显现,缺的不止是硬件落地

    数字孪生是从真实世界到虚拟世界的1 1映射 它通过控制虚拟世界中的生产过程和生产设备 模拟现实世界中的工业生产 更加注重 从虚拟到真实 工业元宇宙所反映的虚拟世界不仅具有现实世界的映射 而且具有现实世界中尚未实现甚至无法实现的体验和互动 这
  • Python实现发送邮件

    SMTP模块发送普通邮件 import smtplib from email mime text import MIMEText from email header import Header 发送方邮箱 msg from 授权码 pass
  • 实习周记1:跨vlan通信

    跨vlan通信 1 拓扑图 2 要求 不同vlan的两台pc通过二层交换机实现二层互通 3 命令 H3C GigabitEthernet2 0 1 port link type hybrid 把端口模式改为hydrid H3C Gigabi
  • Sybase服务无法启动

    刚刚改完数据库的最大连接数 重启服务时 却发现服务无法启动 找了大半天的原因 终于找到了 可惜不会弄 只好有网上搜索一下 发现这种问题还比较常见 服务起不来 在应用程序事件查看器中发现有如下错误 300122 The value of th
  • 工程师的基本素质

    昨天开会 印象最为深刻的是领导的这么一句话 工程师的基本素质 专注 专心 责任 放心 真的 我没有真正意识到并做到这些 所以对于人的准则的教育是必须的 要让人认识到 职责所在 用心做事 愧对自己 洗心革面矣
  • 【调制BFSK】二进制频移键控FSK的数字调制(Matlab代码实现)

    欢迎来到本博客 博主优势 博客内容尽量做到思维缜密 逻辑清晰 为了方便读者 座右铭 行百里者 半于九十 本文目录如下 目录 1 概述 2 运行结果 3 参考文献 4 Matlab代码实现 1 概述 相移键控 PS K 是利用载波相位直接表示
  • python给图片添加水印图片_python 给图片添加数字水印示例

    实例简介 实例截图 核心代码 coding utf 8 Spyder Editor This is a temporary script file from PIL import Image import numpy as np count
  • pycuda学习笔记(二)

    1 pycuda driver LogicError cuDeviceGet failed initialization error报错怎么办 Traceback most recent call last File usr lib pyt
  • 0-1背包问题:动态规划的经典应用

    文章目录 引言 背包问题简介 0 1背包问题定义 0 1背包问题的限制条件 动态规划解决思路 状态定义 状态转移方程 背包问题的Java实现 示例与分析 总结 引言 背包问题是在给定一组物品和一个背包容量的情况下 如何选择物品放入背包 以使
  • 人工智能里有至简的优雅吗?

    我很喜欢这首古诗 静夜思 唐 李白 床前明月光 疑是地上霜 举头望明月 低头思故乡 二十个简单汉字 勾画出生动的画面 并在无数人心里掀起波澜 物理学里 爱因斯坦用5个符号 简单到不能再简单 揭示了我们的世界的规律 目光转回我的本行 我在模式
  • 一文搞定全进程间通讯(IPC)八大方式-管道、命名管道、信号、信号量、消息队列、共享内存+内存映射、套接字

    目录 进程间通讯 IPC UNIX IPC 管道 Pipe 命名管道 FIFO 信号 Signal System V IPC 信号量 Semaphore 消息列队 Message Queue 共享内存 Shared Memory IPC 额
  • linux 中增加路由(route)命令详解

    linux route 命令 route n显示现在所有路由 root Ubuntu route 结果是自上而下 就是说 哪条在前面 哪条就有优先 前面都没有 就用最后一条default 添加一条路由 发往192 168 62这个网段的全部
  • 代码走查该走查什么

    代码走查在很多公司都是一个必要的过程 但是很多时候却时候一个形同虚设的过程 通常检查的同事只要保证你的代码能够编译通过 不出现问题就pass了 到底代码走查有没有一定的规范性呢 如果公司是严格按照开发流程来的话 那么代码走查可能也会是下图中