5.6实验3:编码规范2

[实验任务二]代码规范和评审模板的建立

实验要求:

  1. 根据自己的编程习惯和缺陷,建立自己的代码规范代码评审检查表,并且今后务必加以使用;
  2. 需要提交代码规范和代码评审检查表两个表格,使用Word即可。
  3. 可参考google的代码规范https://google.github.io/styleguide/也可以参考deepseek
  4. 需要提供两种常用语言的代码规范和评审检查表,建议是C++pythonJavapython两种语言共四个表格

Java 代码规范

类别

规范细则

命名规则

- 变量/方法:lowerCamelCase(如 studentName)
- 类/接口:UpperCamelCase(如 StudentService)
- 常量:UPPER_CASE(如 MAX_SIZE)

缩进与空格

- 使用4个空格缩进(禁止Tab)
- 运算符两侧加空格(如 int sum = a + b)
- 方法参数逗号后加空格(如 method(a, b, c))

注释

- 类/方法:/​**​ Javadoc */ 说明功能、参数、返回值
- 复杂逻辑:// 行内注释

代码结构

- 类成员顺序:字段 → 构造方法 → 方法
- 访问修饰符顺序:public → protected → private

异常处理

- 捕获具体异常(如 catch (IOException e))
- 避免 catch (Exception e) 泛化处理

代码复用

- 使用接口和抽象类减少重复代码
- 避免过长方法(建议不超过50行)

Java 代码评审检查表

检查项

/否

备注

命名是否符合规范?

检查类、方法、变量命名风格

缩进和空格是否一致?

确保无Tab,运算符两侧空格

是否有必要的Javadoc?

公共类和方法需写文档注释

是否避免魔法数字?

常量应定义(如 final int MAX_SIZE = 100)

异常处理是否合理?

避免吞没异常或过度泛化的 catch

代码重复率是否过高?

检查是否可通过接口/工具类复用代码

线程安全是否考虑?

多线程环境需加锁或使用并发工具类

C++ 代码规范

类别

规范细则

命名规则

- 变量/函数:lowerCamelCase(如 studentName)
- 类/结构体:UpperCamelCase(如 StudentInfo)
- 宏/常量:UPPER_CASE(如 MAX_SIZE)

缩进与空格

- 使用4个空格缩进,禁止Tab
- 运算符两侧加空格(如 a = b + c)

注释

- 函数头注释:/// 说明功能、参数、返回值
- 关键逻辑:// 行内注释

文件结构

- .h 声明,.cpp 实现
- #include 分组(标准库、第三方库、本地头文件)

错误处理

- 使用异常(try/catch)而非错误码
- 资源管理:RAII(如智能指针 std::unique_ptr)

C++ 代码评审表

检查项

/否

备注

命名是否符合规范?

检查变量、函数、类命名风格

缩进和空格是否一致?

确保无Tab,运算符两侧空格

头文件是否避免循环依赖?

检查 #include 顺序和必要性

内存管理是否安全?

使用智能指针,避免裸 new/delete

异常处理是否完备?

关键路径是否有 try/catch?

posted @ 2025-05-19 08:54    阅读(30)  评论(0)    收藏  举报