让我们来谈谈另一个开发人员的基本原则, 这一个是注释您的代码｡
到目前为止, 你可能已经看到我的评论, 添加评论到我们的脚本｡
例如, 我在这里添加了一个布尔值的注释, 这告诉Python解释器, 这是一个注释,
不要运行它.
这是给我的
你可以忽略它, 直接跳到第二行｡
你看到了吗？
我只是在Python中使用了磅号｡
只要Python看到一个磅符号, 它就会添加一个注释, 你也可以在一行之后这样做｡
我可以说这个赋值给一个变量｡
虽然这看起来像两条线, 但实际上这只是病房里正在发生的说唱｡
你可以看到解释器完全忽略了这些注释｡
现在, 评论听起来非常非常简单, 但它是一个重要的概念｡
如果你想成为一个好的程序员在所有的语言, 我们有注释｡
但是评论的方式有好有坏｡
这是练习的结果｡
但这里有一些关键的指导原则｡
当您对代码进行注释时, 您的想法是添加有价值的注释｡
也就是说, 如果我在这里添加一个注释, 说, 嘿, 这是一个符号名变量, 一个Andre字符串的值,
这样的注释｡
并不是真的好｡
为什么会这样呢？
好吧, 因为你的代码应该是自我解释的, 对吗？
我们的想法是编写易于阅读､ 易于理解的代码｡
这不是耍小聪明｡
相反, 它应该读起来像英语｡
任何一个python程序员都知道我们只是简单地把Andre作为name的值添加进去｡
我们分配了一个变量并添加了这样一条注释, 它本身就是说明性的｡
只会增加代码的混乱程度｡
所以这里有一个权衡｡
如果你在团队中工作, 其他开发人员来了, 他们想了解你的代码, 那么对你的代码进行注释是很好的｡
但是你必须记住代码易读的原则｡
您只需要在程式码中加入注解｡
好吧, 当一些非常非常重要的事情发生时, 它可能有点复杂, 你首先要决定,
嘿, 这段代码的编写方式是否合理？
例如, 如果这是变数a｡
这就是变量B｡
好吧, 这可能真的很难让人理解｡
所以你可能会说这是一面旗帜｡
但是在添加那个注释之前, 你想对自己说, 嗯, 也许我的代码很难读懂｡
也许我应该把变量改为“很酷”, 让它更容易理解｡
现在, 这是您越来越多地改进的地方, 并且您确实希望使用注释作为额外的工具, 以使您的代码易于理解｡
也许你写的代码六个月后你想回去了解你做了什么｡
但是请记住, 更多的注释并不一定意味着更好的代码｡
您希望保持简洁, 同时只在必要时添加注释以帮助其他人理解您的代码,
而不是试图使您的不可读代码变得更可读｡
在整个课程中, 我们将探讨这个主题, 并就此给予建议｡
但是请记住这一关键的开发人员基础知识, 因为您在整个职业生涯中都需要它｡
顺便说一下, 这篇文章有一些非常重要的观点, 我认为您会从中受益,
特别是在评论最佳实践方面｡
你可以阅读一些做什么和不做什么, 以及一些顶级程序员在评论时做什么｡
我知道这听起来很傻, 但这是一个重要的概念, 大多数课程都忽略了, 所以我强烈建议你仔细阅读这篇文章｡
我将在参考资料中链接到它, 我们将在下一个视频中再见｡