Python中什么情况下需要使用注释?

234 篇文章 6 订阅
136 篇文章 0 订阅

在注释代码的时候我们应当注意:

注释不是越多越好,对于一目了然的代码,不需要添加注释

对于 复杂的操作,应该在操作开始前写上若干行注释

对于 不是一目了然的代码,应在其行尾添加注释(为了提高可读性,注释应该至少离开代码 2 个空格)

绝不要描述代码,假设阅读代码的人比你更懂 Python,他只是不知道你的代码要做什么

在一些正规的开发团队,通常会有代码审核的惯例,就是一个团队中彼此阅读对方的代码,找出和发现在开发中出现的错误并及时订正,预防代码出现错误,提高代码的安全性。减少后期的软件检查。而注释代码就是为了给同事或者同行提供便利,以求更快的理解你写这行代码的意思,知道你要做什么。

关于代码规范

Python 官方提供有一系列 PEP(Python Enhancement Proposals) 文档

其中第 8 篇文档专门针对 Python 的代码格式 给出了建议,也就是俗称的 PEP 8

文档地址:https://www.python.org/dev/peps/pep-0008/

谷歌有对应的中文文档:http://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值