Redis是怎样写代码注释的？

备份注释是开拓职员对某些代码块的旧版本乃至是整个函数做出的注释，由于他/她对新版本中运行的变动放不下心。令人费解的是，此刻有了Git，人们却还在行使这类注释。我想人们对付丢失代码片断有一种不安详感，已往提交接码时，行使备份注释会显得越发理智靠得住。

但源代码并不是用来备份的。假如你必要生涯旧版本的函数或代码，声名你的事变尚未完成，也无法提交。要么确保新函数比已往的更好，要么只在开拓树(development tree)中行使它，直到你确定为止。

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

总结

注释是和将来的代码读者谈天，读者们还能在Twitter上评价你的注释。以是在这个进程中，你真心地在审阅本身所注释的内容是否“能让人接管”，看本身写得是否足够面子、足够好。假如不是，你就勤用功恳地再做一遍，拿出更好的注释来。

你也许以为编写注释不是个高端事变。事实你“会写代码”!但请思量这一点：代码是一组语句和函数挪用(可能你做的其他编程典型也一样)。假如代码写得欠好，这些语句就没有多大意义。注释经常要求你举办一些计划进程，并从更深条理来领略你正在编写的代码。

最重要的是，为了写出好的注释，你必需作育本身的写作手段。这种写作能力能帮你更好地编写电子邮件、文案、计划文档、博客文章和提交文件。

我写代码是由于我急切想要与他人雷同交换、分享设法。注释可以或许为代码提供辅佐，把作者的心血示意出来。说到底，我喜好写注释，就像我喜好写代码一样。

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

【编辑保举】

1. 阿里数据库的极致弹性之路
2. 如履薄冰：Redis懒惰删除的庞大捐躯
3. 运维 | 美团数据库智能运维试探与实践
4. 数据库首要特点是掩护数据的安详性和靠得住性以及正确性和有用性
5. Redis主从架构机制是什么，考考你对Redis领略深度

（编辑：湖南网）

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