# 2. #及注释




### 背景

注释是代码中非常重要的部分，一般来说注释的作用有下面一些

* 告诉你这段代码中实现了些什么，帮助你或其他阅读代码的人去理解代码
* 暂时让某段代码失效


### 代码实现

新建名为```report_with_comments.py```的文本文件，用文本编辑器打开，输入如下内容:

```python
# 打印出本次测试的测试结果

print('本次测试功能点5个') # 本次回归测试涉及到多个功能点
print('测试用例20个') # 这些功能点一共编写了多少用例
print('共执行测试用例20个') # 回归了多少个
print('共发现缺陷0个') # 这些用例总用发现了多少个缺陷
print('用例通过率100%') # 通过率计算公式: 执行成功的用例/用例总数

# 结束打印
print('回归通过')
```

注意: 照着上面代码敲一遍，敲完以后检查一遍，因为对于新手来说，一次性就敲准确不那么容易。


### 运行

在命令行中使用下面的命令去执行代码

```
python report_with_comments.py
```

### 你应该可以看到

如果没有出错的话，你应该可以看到命令行窗口显示如下的内容

```
本次测试功能点5个
测试用例20个
共执行测试用例20个
共发现缺陷0个
用例通过率100%
回归通过
```

### 动手时间

* 自己搞清楚```#```的作用是什么
* 把上面的代码大声读出来，没错，跟读课文一样读出来，看能不能找到自己代码中的错误
* 把上面的代码反过来阅读一遍，这次就不用读出声来了，看能不能发现更多的错误

### 常见问题

* ```print('Hi, # there')```中的"#"为什么没有注释的作用？ 因为当"#"在字符串中(字符串就是用一对单引号或双引号包围的文本或文字)的时候，"#"就不再是注释的符号，而是只是一个普通字符，会被原原本本打印出来

* **如何注释多行代码呢？** 在每一行前面都加个"#"号

* **为什么我需要倒过来读代码？** 这可以让你换个角度看自己写的东西，更容易发现代码中的错误




原始封面

![课程图片](https://images.unsplash.com/photo-1516315720917-231ef9acce48?w=300)