提交 e2b2dd4e 编写于 作者: Q qq_36105691

doc

上级 19919d3d
......@@ -15,20 +15,20 @@
|-----------------------------------------|----------------------------------|:--------:|:--------:|
| Planning | 计划 | 30 | 30 |
| · Estimate | 估计这个任务需要多少时间 | 30 | 30 |
| Development | 开发 | 480 | 480 |
| Development | 开发 | 1560 | 1860 |
| · Analysis | 需求分析 | 60 | 60 |
| · Design Spec | 生成设计文档 | 60 | 60 |
| · Design Review | 设计复审 | 60 | 60 |
| · Coding Standard | 代码规范 | 60 | 60 |
| · Design | 具体设计 | 60 | 60 |
| · Coding | 具体编码 | 180 | 180 |
| · Design Spec | 生成设计文档 | 30 | 30 |
| · Design Review | 设计复审 | 30 | 30 |
| · Coding Standard | 代码规范 | 30 | 30 |
| · Design | 具体设计 | 30 | 30 |
| · Coding | 具体编码 | 1200 | 1500 |
| · Code Review | 代码复审 | 60 | 60 |
| · Test | 测试 | 60 | 60 |
| Reporting | 报告 | 60 | 60 |
| · Test Report | 测试报告 | 60 | 60 |
| · Size Measurement | 计算工作量 | 60 | 60 |
| · Postmortem & Process Improvement Plan | 事后总结, 并提出过程改进计划 | 60 | 60 |
| Summary | 合计 | 570 | 570 |
| · Test | 测试 | 120 | 120 |
| Reporting | 报告 | 360 | 360 |
| · Test Report | 测试报告 | 30 | 30 |
| · Size Measurement | 计算工作量 | 30 | 30 |
| · Postmortem & Process Improvement Plan | 事后总结, 并提出过程改进计划 | 300 | 300 |
| Summary | 合计 | 1950 | 2250 |
## 3. 解题思路描述
......
请参照[《码出高效_阿里巴巴Java开发手册》](https://github.com/chjw8016/alibaba-java-style-guide)/《腾讯c++代码规范》等主流代码规范,从至少以下几个角度制定你的编程规范。请牢记你制定的编码规范,并在此次作业中严格执行!
- 缩进
- 变量命名
- 每行最多字符数
- 函数最大行数
- 函数、类命名
- 常量
- 空行规则
- 注释规则
- 操作符前后空格
- 其他规则
# 编程规范
## 1. 缩进
- 使用4个空格进行缩进,不使用制表符(Tab)。
```cpp
void exampleFunction() {
if (condition) {
doSomething();
} else {
doSomethingElse();
}
}
```
## 2. 变量命名
- 变量名使用小驼峰命名法(camelCase)。
- 变量名应当具有描述性,清晰明了,避免使用单个字符或者不具有含义的缩写。
```cpp
int numberOfStudents;
std::string customerName;
```
## 3. 每行最多字符数
- 每行最多不超过80个字符,超出部分换行处理。
- 换行时应当遵循语义上的合理性,如在逗号后、运算符前等位置换行。
```cpp
int result = someFunction(argument1, argument2, argument3,
argument4, argument5);
```
## 4. 函数最大行数
- 函数最大行数不超过100行。
- 函数应当具有单一职责,避免函数过长。
- 如果函数过长,应当考虑是否可以拆分成多个函数。
## 5. 函数、类命名
- 函数名使用小驼峰命名法(camelCase)。
- 类名使用大驼峰命名法(PascalCase)。
```cpp
class ExampleClass {
void exampleFunction();
};
```
## 6. 常量
- 常量使用全大写,单词间用下划线分隔。
- 使用常量来代替魔法数值,增加代码的可读性和可维护性。
```cpp
const int MAX_NUMBER = 100;
```
## 7. 空行规则
- 使用空行来划分逻辑上相关的代码块,增强代码的可读性。
- 函数之间、类的成员函数之间应当使用空行分隔。
- 函数内逻辑上相关的代码段之间可以适当使用空行分隔。
```cpp
void function1() {
// Code block 1
}
void function2() {
// Code block 2
}
```
## 8. 注释规则
- 使用`//`进行单行注释,使用`/* */`进行多行注释。
- 注释应当清晰明了,避免使用无意义的注释。
- 注释应当与代码同步更新,保持注释的准确性。
```cpp
// This is a single line comment
/*
* This is a multi-line comment
*/
```
## 9. 操作符前后空格
- 在操作符前后添加空格,增强代码的可读性。
```cpp
int result = a + b;
```
## 10. 其他规则
- 不使用`using namespace`, 避免命名空间污染。
- 使用`nullptr`代替`NULL`
- 使用`enum class`代替`enum`
- 尽量避免使用全局变量,减少代码的耦合性。
- 使用**CLion**等IDE进行代码格式化,保持代码风格的一致性。
#include "UserInput.h"
using namespace Mika;
int main(int argc, char *argv[], [[maybe_unused]] char *envp[]) {
UserInput::getInput(argc, argv);
Mika::UserInput::getInput(argc, argv);
return 0;
}
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册