代码走查检查单

最新推荐文章于 2024-10-31 13:49:41 发布
最新推荐文章于 2024-10-31 13:49:41 发布
阅读量628 收藏 4
点赞数
CC 4.0 BY-SA版权
文章标签： C C++ C# 工作
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/zhaowei30/article/details/83396434

      1代码的注释与代码是否一致?注释是否是多余的?

　　2是否存在超过3层嵌套的循环与/或判断?

　　3变量的命名是否代表了其作用?

　　4所有的循环边界是否正确?

　　5所有的判断条件边界是否正确?

　　6输入参数的异常是否处理了?

　　7程序中所有的异常是否处理了?

　　8是否存在重复的代码?

　　9是否存在超过20行的方法?

　　10是否存在超过7个方法的类?
      11方法的参数是否超过3个?

　　12是否有多种原因导致修改某个类?

　　13当发生某个功能变化时，是否需要修改多个类?

　　14代码中的常量是否合适?

　　15一个方法是否访问了其他类的多个属性?

　　16某几项数据是否总是同时出现，而又不是一个类的属性?

　　17switch语句是否可以用类来替代?

　　18是否有一类的职责很少?

　　19是否有一个类的某些属性或者方法没有被其他类所使用?

　　20在类的方法中是否存在如下的调用形式：a.b().c()?
      21是否某个类的方法总是调用另外一个类的同名方法?

　　22是否某个类总是访问另外一个类的属性与方法?

　　23是否两个类完成了类似的工作，使用了不同的方法名，却没有拥有同一个父类?

　　24是否某个类仅有字段和简单的赋值方法与取值方法构成?

　　25是否某个子类仅使用了父类的部分属性或方法?

willzhao
关注
代码走查单（很详细的资料）
10-30
很详细的代码走查单，有需要的人赶快下载吧！
代码走查检查单.xls
08-07
代码走查单，代码检查。
一个典型的代码走查检查单
weixin_30569001的博客
01-04 420
转载地址(source)：http://testing.youkuaiyun.com/page/3cd02569-5942-4d7f-96c2-3dbbd481b700 代码走查的最主要的目的是为了发现程序中的逻辑错误，编程风格方面的错误可以通过风格检查的工具去检查。如下的检查单给代码走查的专家发现逻辑错误提供了一个很好的帮助。 　　序号检查项 　　1代码的注释与代码是否一致?注释是否是多余的?...
典型代码走查检查单
studyvcmfc的专栏
06-28 2470
 【IT168技术文章】代码走查的最主要的目的是为了发现程序中的逻辑错误，编程风格方面的错误可以通过风格检查的工具去检查。如下的检查单给代码走查的专家发现逻辑错误提供了一个很好的帮助。序号检查项序号检查项1、代码的注释与代码是否一致?注释是否是多余的?2、是否存在超过3层嵌套的循环与/或判断?3、变量的命名是否代表了其作用?4、所有的循环边界是否正确?5、所有的
代码走查
业精于勤荒于嬉;行成于思，毁于随。
09-02 4122
代码走查(code walkthrough)是一个开发人员与架构师集中与讨论代码的过程。代码走查的目的是交换有关代码是如何书写的思路，并建立一个对代码的标准集体阐述。 在代码走查的过程中，开发人员都应该有机会向其他人来阐述他们的代码。 通常地，即便是简单的代码阐述也会帮助开发人员识别出错误并预想出对以前麻烦问题的新的解决办法。 当团队成员对代码进行讨论的时候，他们的讨论应该集中到一些重要的话
嵌入式系统C代码走查检查单(编程必看).doc
02-28
嵌入式系统C代码走查检查单 嵌入式系统C代码走查检查单是指在编写和维护嵌入式系统C代码时，需要遵守的一系列规范和检查项。这些规范和检查项旨在确保代码的可读性、可维护性和可靠性，避免常见的错误和 Bug。 一...
代码走查检查表模板.xls
01-09
代码检查
项目代码走查单(示例).xls
06-23
项目代码走查单作为日常IT项目管理 的有效工具，适合在项目研发上线前评估项目代码使用，以检测代码中可能存在的风险
前端-代码走查模板.docx
12-23
在前端项目管理中，代码走查是一个至关重要的环节，它有助于规范开发行为，统一团队内的编码风格，并且能够提前发现并修复潜在的问题，提高代码质量和软件稳定性。代码走查不仅是一种质量保证手段，而且能够促进团队...
代码走查记录表
11-09
制定代码走查标准，记录代码走查路径，代码走查代码数，缺陷数，负责人，建议修改意见，检查人，检查时间，是否修改，修改意见，修改人，修改时间，审核是否通过，审核人，审核时间；并进行合计总检查代码数，缺陷总数，计算缺陷率等。
代码走查表
08-01
代码走查，每天要做，代码走查表格，每天都要修改，
代码走查记录表 模板
09-07
项目代码走查记录表 描述检查人员 检查时间，检查发现那些问题等等。
【亲测免费】 嵌入式系统C代码走查检查单
gitblog_06675的博客
10-31 364
嵌入式系统C代码走查检查单 【下载地址】嵌入式系统C代码走查检查单分享 嵌入式系统C代码走查检查单 项目地址: https://gitcode.com/Open-source-documentation-tutorial/cce4...
java 代码走查_代码走查检查表（JAVA）.doc
weixin_42303078的博客
02-12 1235
代码走查检查表(JAVA).doc代码走查检查表项目名称： 模块名称： 版本号：检查时间： 检查员：#检查项是/否/不适用注释命名、注释及风格文件、类/接口、静态变量、成员变量、方法及关键代码是否都有格式良好、简明扼要、的注释？注释是否是对设计思路的说明而不仅仅是代码行为的...
代码检查清单
路漫漫其修远兮 吾将上下而求索
03-14 598
自己的写的方法不要返回null,如果是null则调用方也要进行验证是否为空，如果调用第三方代码则需要进行判断是否为null，返回值需要在代码注释写清楚。前端和后端不是同时进行的，因此需要前端先做初步的判断，如果完全在自测测的时候并不能考虑很细节，考虑到每一个接口的事情。代码的注释：坏注释都是糟糕代码的支撑或借口，或者是对错误决策的修正，基本上等于程序员自说自话。在解决问题时，需要考虑其相关性、将问题所涉及的其他场景列出，并且检查。减少发包次数，实在遇到堵塞问题则进行发包，减少发包时间。
学生管理系统项目代码走查单
最新发布
04-19
<think>嗯，用户需要学生管理系统项目的代码走查单或相关规范，模板和示例。首先，我需要理解代码走查单是什么，通常包括哪些内容。代码走查单用于检查代码质量，确保符合编码规范，没有潜在错误。根据用户提供的引用，可能可以参考范围管理中的WBS分解原则，比如完整性、唯一归属等，应用到代码检查中。 用户提到的引用[1]中关于WBS的分解原则，比如保持完整性、避免重复，可能需要对应到代码检查的不同模块，比如功能模块、数据库设计、接口等。引用[2]提到持续集成流程，可能涉及代码编译、测试等步骤，可以关联到代码走查的自动化测试部分。引用[3]强调团队协作，可能代码走查需要团队共同遵守规范。 接下来，我需要构建一个结构清晰的走查单模板，分为基础规范、功能模块、安全与性能、测试与文档等部分。每个部分需要具体的检查项，例如命名规范、注释、异常处理、SQL注入防护等。同时，要结合引用中的内容，例如工作包的责任人对应代码走查中的责任人，WBS词典对应文档说明。 用户可能需要示例代码，所以应该提供一些简单的代码片段，比如使用参数化查询防止SQL注入，并注释规范。此外，生成相关问题时要考虑用户可能的后续需求，比如如何实施代码审查流程或自动化工具推荐。 需要注意用户可能对代码规范的具体细节不太清楚，所以需要给出常见的检查点，比如缩进、日志记录、输入验证等。同时，结合引用中的项目管理和持续集成，可以建议将走查单集成到CI/CD流程中，如Jenkins的自动化检查步骤。 最后，确保回答符合中文要求，使用正确的LaTeX格式，行内公式用$...$，独立公式用$$...$$，但在这个问题中可能数学公式较少，但如果有性能指标可能需要用到，比如响应时间≤2秒等，用适当格式。检查是否有遗漏部分，确保模板示例和问题相关，帮助用户进一步深入。</think>### 学生管理系统代码走查单模板（示例） #### 一、基础规范检查 1. **命名规范** - 变量/函数名是否使用`小驼峰`或`蛇形命名`（如`studentName`或`student_name`）？ - 类名是否使用`大驼峰`命名（如`StudentInfoService`）？ 2. **代码结构** - 是否遵循MVC分层原则（Controller仅处理请求，Service处理业务逻辑，Dao操作数据库）？ - 重复代码是否封装为公共函数或工具类（如日期格式化函数）？ 3. **注释与文档** - 复杂逻辑是否有注释说明（如`// 根据学号哈希分库，避免热点数据`）？ - 接口方法是否有Swagger或Javadoc注释（参数说明、返回值示例）？ ```java // 示例：接口注释规范 /** * 根据学号查询学生信息 * @param studentId 学号（需符合格式STU-2023-XXXX） * @return StudentDTO 包含姓名、班级、成绩等字段 */ public StudentDTO getStudentInfo(String studentId) { ... } ``` --- #### 二、功能模块检查 1. **核心业务逻辑** - 学号生成规则是否包含校验位（如`STU-2023-001`末位为校验码）？ - 成绩录入是否限制范围（如$0 \leq \text{分数} \leq 100$）？ 2. **异常处理** - 是否捕获数据库连接超时异常（如`SQLTimeoutException`）？ - 用户输入是否进行合法性校验（如防止SQL注入、XSS攻击）？ ```python # 示例：参数化查询防止SQL注入 cursor.execute("SELECT * FROM students WHERE id = %s", (student_id,)) ``` --- #### 三、安全与性能 1. **数据安全** - 敏感信息（如密码）是否加密存储（使用BCrypt或SHA-256哈希）？ - 接口是否增加权限注解（如`@PreAuthorize("hasRole('ADMIN')")`）？ 2. **性能优化** - 高频查询是否使用缓存（如Redis存储学生班级信息）？ - 数据库是否添加索引（如对`student_id`字段建立唯一索引）？ --- #### 四、测试与部署 1. **单元测试** - 核心方法是否有JUnit/TestNG测试用例（覆盖率≥80%）？ - 是否模拟边界条件（如学号为空、成绩为负数）？ 2. **部署规范** - 配置文件是否与代码分离（如使用`application.yml`管理环境变量）？ - 是否提供Dockerfile或Kubernetes部署脚本？ --- ### 代码走查单示例片段 | 检查项 | 符合要求(Y/N) | 备注 | |-----------------------|---------------|-----------------------------| | 学号生成规则校验 | Y | 校验位算法通过测试用例 | | 成绩录入范围限制 | N | 未处理分数为负数的情况 | | SQL注入防护 | Y | 使用MyBatis参数化查询 | --- ### 相关规范参考 1. **代码分层**：参考WBS分解原则，确保模块职责单一[^1]。 2. **持续集成**：可结合Jenkins定制代码扫描流程（如SonarQube静态检查）[^2]。 3. **团队协作**：需统一团队编码规范，通过Git Hooks强制预检查[^3]。 ---
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值