Python快速入门 | 为了别被“我操尼玛”,还是好好写代码注释吧

其实你写的代码,除了给电脑执行之外,还需要被人看,比如你自己,你的合作伙伴。在这个时候,你别指望人能和电脑一样,能够清楚且清晰的看懂所有你写的代码。

为了让你的代码能够易于理解,易于阅读,让别人或者往后的你自己回过头来看你写的代码,也能够快速理解,知道你写的这些代码是干嘛的。你必须好好的写好代码注释,所谓注释,就是给人看的,不会被电脑执行的一些 “人话” 解释。

注释的方式有这么几种:

本文隐藏内容 登陆 后才可以浏览
长期来看,注释代码肯定是百利无害的,不过需要注意一点的是,前提是你自己的代码要写得好看又易懂,再加上一点注释 “点缀” 一下,而不是写一丢丢不知道什么鬼的代码,然后用几十行注释来解释,这就本末倒置了。

Python 还提供了一个叫 docstring 的玩意,本质上也是一种注释,不过它可以和文档结合起来,这个等我跟你说完模块之后,跟你说说怎么玩。

3 Replies to “Python快速入门 | 为了别被“我操尼玛”,还是好好写代码注释吧”

发表评论

电子邮件地址不会被公开。 必填项已用*标注