Redis是如何写代码注释的？

备份注释是开发人员对某些代码块的旧版本甚至是整个函数做出的注释，因为他/她对新版本中运行的更改放不下心。令人费解的是，现在有了Git，人们却还在使用这类注释。我想人们对于丢失代码片段有一种不安全感，过去提交代码时，使用备份注释会显得更加理智可靠。

但源代码并不是用来备份的。如果你需要保存旧版本的函数或代码，说明你的工作尚未完成，也无法提交。要么确保新函数比过去的更好，要么只在开发树(development tree)中使用它，直到你确定为止。

备份注释是我分类中的最后一项。我们来做个总结。

总结

注释是和未来的代码读者聊天，读者们还能在Twitter上评价你的注释。所以在这个过程中，你真心地在审视自己所注释的内容是否“能让人接受”，看自己写得是否足够体面、足够好。如果不是，你就勤勤恳恳地再做一遍，拿出更好的注释来。

你可能认为编写注释不是个高端工作。毕竟你“会写代码”!但请考虑这一点：代码是一组语句和函数调用(或者你做的其他编程范例也一样)。如果代码写得不好，这些语句就没有多大意义。注释常常要求你进行一些设计过程，并从更深层次来理解你正在编写的代码。

最重要的是，为了写出好的注释，你必须培养自己的写作能力。这种写作技巧能帮你更好地编写电子邮件、文案、设计文档、博客文章和提交文件。

我写代码是因为我迫切想要与他人沟通交流、分享想法。注释能够为代码提供帮助，把作者的心血表现出来。说到底，我喜欢写注释，就像我喜欢写代码一样。

注：英文原文太长，翻译后有删减。

【编辑推荐】

1. 阿里数据库的极致弹性之路
2. 如履薄冰：Redis懒惰删除的巨大牺牲
3. 运维 | 美团数据库智能运维探索与实践
4. 数据库主要特点是保护数据的安全性和可靠性以及正确性和有效性
5. Redis主从架构机制是什么，考考你对Redis理解深度

（编辑：PHP编程网 - 黄冈站长网）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!