代码走读

2024-06-21 17:18
文章标签 代码 走读

本文主要是介绍代码走读,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

                              代码走读原则

一:准备工作

 

  结论(是 / 否)

1:目录层次结构是否遵循标准?

 

2:流程图是否清晰?是否能从流程图判断该模块的结构?

 

3:注释文档是否清晰完全?

 

4readme文档是否遵循标准?

 

5:是否可在模拟器上运行?

 

二:程序结构:

 

  结论(是 / 否)

1:代码是否按照功能模块化?

 

2:标准数据的操作是否单独封装在一个文件,gui解耦?

 

3:配置文件的操作是否单独封装在一个文件,gui解耦?

 

4:涉及的独立的算法是否单独封装在一个文件,gui解耦?

 

5:每个窗口界面是否单独封装在一个文件?

 

6 .c必须用相应的.h给外部引用函数、数据、对象等

 

7:所有代码的结构是否清晰,具有良好的结构外观和整齐?

 

8:所有的模块都定义得很好,包括函数和外部接口?

 

9:每个文件是否只包含一个模块的代码?

 

10:文件的命名是否可以体现出该文件的作用?

 

11:你觉得这个体系结构舒服吗?

 

三:函数检查

 

  结论(是 / 否)

1:函数的名字是否清晰的定义了它的目标以及函数所做的事情?

 

2:函数是否高内聚只做一件事情,并做好?

 

3:函数中的语句是否都在同一个抽象级上?

 

4:函数的参数是否合理,能否尽量控制在3个以内,必要时可以超过3个;

 

5:输出参数是否合理?

 

6: 在保证代码清晰的前提下,函数是否使用了最少数目的return语句,除非不可以?

 

7:是否有重复代码?或者相似的代码可以分离出来?

 

8:你觉得这个函数看起来舒服吗?

 

四:变量

 

  结论(是 / 否)

1:变量的命名是否完全的、明确的描述了该变量代表什么?

 

2:程序是否使用了特别的、易误解的、发音相似的命名?

 

3:是不是所有的变量都有最小的活动范围?

 

五:注释

 

  结论(是 / 否)

1:每个文件和模块是否解释?

 

2:源代码是否自我解释?

 

3:解释是不是仅仅作为代码的重复?解释的过于简单?

 

4:注解是否清楚正确?

 

5:注解是否为读者服务?

 

 

六:资源

 

  结论(是 / 否)

1:IO操作是否释放资源?

 

2:数据库连接是否释放?

 

3:socket连接是否正确关闭?

 

4:内存空间是否出现陡峰?

 

5:连接数是否达到预期要求?

 

6:分配的空间是否会造成系统负荷工作?

 

7:数据库锁是否会被占用导致阻塞?

 

 

七:服务

 

  结论(是 / 否)

1:业务流程是否进行划分?

 

2:服务是否进行拆分?

 

3:服务之间是否紧耦合?

 

4:服务是否具有可扩展性?

 

5:服务是否为分布式服务?

 

6:服务是否有相应的服务文档?

 

7:服务安全性是否有保证?

 

8:服务是否可独立运行?

 

 

八:架构

 

  结论(是 / 否)

1:是否面向接口编程?

 

2:是否是服务型架构?

 

3:数据库是否进行主备备份?

 

4:数据库是否进行读写分离?

 

5:应用层是否设置缓存?

 

6:容错性是否考虑?

 

7:是否可扩展(水平和垂直扩展)?

 

8:是否对系统进行监控?

 

9:是否对高并发进行处理(削峰填谷等措施)?

 

 

这篇关于代码走读的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1081841

相关文章

C#实现千万数据秒级导入的代码

《C#实现千万数据秒级导入的代码》在实际开发中excel导入很常见,现代社会中很容易遇到大数据处理业务,所以本文我就给大家分享一下千万数据秒级导入怎么实现,文中有详细的代码示例供大家参考,需要的朋友可... 目录前言一、数据存储二、处理逻辑优化前代码处理逻辑优化后的代码总结前言在实际开发中excel导入很

SpringBoot+RustFS 实现文件切片极速上传的实例代码

《SpringBoot+RustFS实现文件切片极速上传的实例代码》本文介绍利用SpringBoot和RustFS构建高性能文件切片上传系统,实现大文件秒传、断点续传和分片上传等功能,具有一定的参考... 目录一、为什么选择 RustFS + SpringBoot?二、环境准备与部署2.1 安装 RustF

Python实现Excel批量样式修改器(附完整代码)

《Python实现Excel批量样式修改器(附完整代码)》这篇文章主要为大家详细介绍了如何使用Python实现一个Excel批量样式修改器,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一... 目录前言功能特性核心功能界面特性系统要求安装说明使用指南基本操作流程高级功能技术实现核心技术栈关键函

Redis实现高效内存管理的示例代码

《Redis实现高效内存管理的示例代码》Redis内存管理是其核心功能之一,为了高效地利用内存,Redis采用了多种技术和策略,如优化的数据结构、内存分配策略、内存回收、数据压缩等,下面就来详细的介绍... 目录1. 内存分配策略jemalloc 的使用2. 数据压缩和编码ziplist示例代码3. 优化的

Python 基于http.server模块实现简单http服务的代码举例

《Python基于http.server模块实现简单http服务的代码举例》Pythonhttp.server模块通过继承BaseHTTPRequestHandler处理HTTP请求,使用Threa... 目录测试环境代码实现相关介绍模块简介类及相关函数简介参考链接测试环境win11专业版python

Python从Word文档中提取图片并生成PPT的操作代码

《Python从Word文档中提取图片并生成PPT的操作代码》在日常办公场景中,我们经常需要从Word文档中提取图片,并将这些图片整理到PowerPoint幻灯片中,手动完成这一任务既耗时又容易出错,... 目录引言背景与需求解决方案概述代码解析代码核心逻辑说明总结引言在日常办公场景中,我们经常需要从 W

使用Spring Cache本地缓存示例代码

《使用SpringCache本地缓存示例代码》缓存是提高应用程序性能的重要手段,通过将频繁访问的数据存储在内存中,可以减少数据库访问次数,从而加速数据读取,:本文主要介绍使用SpringCac... 目录一、Spring Cache简介核心特点:二、基础配置1. 添加依赖2. 启用缓存3. 缓存配置方案方案

MySQL的配置文件详解及实例代码

《MySQL的配置文件详解及实例代码》MySQL的配置文件是服务器运行的重要组成部分,用于设置服务器操作的各种参数,下面:本文主要介绍MySQL配置文件的相关资料,文中通过代码介绍的非常详细,需要... 目录前言一、配置文件结构1.[mysqld]2.[client]3.[mysql]4.[mysqldum

Python多线程实现大文件快速下载的代码实现

《Python多线程实现大文件快速下载的代码实现》在互联网时代,文件下载是日常操作之一,尤其是大文件,然而,网络条件不稳定或带宽有限时,下载速度会变得很慢,本文将介绍如何使用Python实现多线程下载... 目录引言一、多线程下载原理二、python实现多线程下载代码说明:三、实战案例四、注意事项五、总结引

IDEA与MyEclipse代码量统计方式

《IDEA与MyEclipse代码量统计方式》文章介绍在项目中不安装第三方工具统计代码行数的方法,分别说明MyEclipse通过正则搜索(排除空行和注释)及IDEA使用Statistic插件或调整搜索... 目录项目场景MyEclipse代码量统计IDEA代码量统计总结项目场景在项目中,有时候我们需要统计