注释的目的

发表于 | 更新于 | 分类于 | 阅读次数：
本文字数： 531 | 阅读时长 ≈ 1 分钟

Real Python

编程语言中的注释有许多用途。

Planning & Reviewing

在开始实现一个功能之前，在最开始的时候，可以利用注释规划要实现的功能的大致轮廓，就像陈述这部分功能应该怎么实现一样。

这部分的注释是比较注重细节的描述了，比如要实现一个从EXCEL文件中读取数据的过程，注释可以这样写：

1
2
3
4
5
6
7
8
# 打开文件
pass

# 读取文件
pass

# 整理数据
pass

代码编写完毕，这种比较繁琐的注释有助于review和测试。正式提交前，这些注释要么删除，要么转化为正式的注释。

我以前写代码的时候习惯用笔在纸上描绘出要实现的功能的具体细节，这么做的话要依赖纸和笔。了解到这种方法后，经过实践，发现完全可以取代我以前的开发习惯。

Code Description

用于解释代码的特定目的

Algorithm Description

当用到某种算法时，特别是比较复杂的算法，注释就非常重要了。

Tagging

用于标注某一块代码有待提升等，常见的tag如BUG, FIX, TODO

参考资料

0%