好好写代码注释

Posted on | In |

所谓注释，就是给人看的，不会被电脑执行的一些“人话”解释

为了让你的代码能够易于理解，易于阅读，
让别人或者往后的你自己回过头来看你写的代码，
也能够快速理解，知道你写的这些代码是干嘛的。

你必须好好的写好代码注释

单行注释

1
2
3
4
5
6
7
8
9
10
11
12
13
import requests
# 根据 url 下载网页内容
def download_html(url):
    try:
        # 通过 request 的 get 请求链接
        response = requests.get(url, headers=headers)  # header 要预先定义
        # 如果返回状态码是 200 ，说明请求成功
        if response.status_code == 200:
            # 返回网页内容
            return response.content
    except requests.RequestException:
        # 请求出现异常，错误捕获处理
        return None

行内注释

1
new_image = Image.new('RGB', (260, 126))  # 创建一张大小相同的图片

多行注释

1
2
3
4
5
6
7
8
9
10
11
12
13
"""
这个 main 函数会接收一个 page 参数，然后构建一个可请求的链接 url
然后使用 request_test 请求这个链接就会得到这个网页的内容 html
接着利用 parse_result 解析得到的 html ，从而获取需要的关键字段信息
最后使用 write_item_to_file 把信息写入文件
"""

def main(page):
    url = 'http://www.example.com/' + str(page)
    html = requests_test(url)
    items = parse_result(html)
    for item in items:
        write_item_to_file(item)