week01 编码规范

编码规范

1. 文件与目录规范• 头文件引用：
   使用 <> 引用系统头文件或预定义路径的头文件，例如 #include <iostream> 。
   使用 "" 引用当前目录或相对路径的头文件，例如 #include "MyHeader.h" 。
   避免在头文件中包含不必要的头文件，以减少编译依赖和提高编译速度。
   头文件内容：
   头文件中只存放声明（如函数声明、类声明、宏定义等），不存放定义（如函数实现、变量定义等），避免重复定义问题。
   使用 #ifndef 、 #define 和 #endif 来防止头文件的重复包含

文件长度：
尽量保持每个文件的长度在1000行以内，以提高代码的可读性和可维护性。如果文件过长，可以考虑将其拆分为多个模块。

2. 代码格式规范
   缩进与空行：
   程序块采用缩进风格编写，缩进空格数为4个空格。
   例如：cppif (condition) { // 缩进4个空格 statement; }
   相对独立的程序块之间、变量声明之后必须加空行，以提高代码的可读性。例如：`cppint a = 1;
   int b = 2;

if (a > b) {
// 空行分隔
std::cout << "a is greater than b" << std::endl;
}操作符与换行： 操作符处划分新行，操作符放在新行之首，并适当缩进。 例如：cppint result = a +
b +
c;不允许把多个短语句写在一行中，一行只写一条语句。 例如：cppint a = 1;
int b = 2; 而不是：cppint a = 1; int b = 2; 对齐与空格： 对齐使用 TAB 键，1个 TAB 对应4个字符位。 例如：cppint a = 1;
int b = 2;`

函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格， case 语句下的情况处理语句也要遵从语句缩进要求。
例如：cppswitch (value) { case 1: // 缩进4个空格 std::cout << "Value is 1" << std::endl; break; case 2: // 缩进4个空格 std::cout << "Value is 2" << std::endl; break; }
分界符：
程序块的分界符（如大括号 { 和 } ）应各独占一行并且位于同一列，与引用它们的语句左对齐。
例如：cppif (condition) { statement;
}
而不是：cppif (condition) { statement; }

3. 变量与函数命名规范
   命名风格
   对于变量和函数名统一使用驼峰命名法。
   例如：cppint myVariable; void myFunction();
   构造函数要以大写字母开头，类名也以大写字母开头。
   例如: cppclass MyClass { public: MyClass(); };
   命名规则：
   变量名和函数名应具有明确的语义，避免使用模糊或无意义的名称。例如，使用 studentCount 而不是 sc 。
   常量名使用全大写字母，单词之间用下划线分隔。例如：cppconst int MAX_SIZE = 100;
   避免使用单字母变量名（除了常见的循环变量 i 、 j 等）。

以上是本学期我将遵循的主要编码规范。这些规范旨在提高代码的可读性、可维护性和一致性，同时也便于团队协作和代码审查。