首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往
您找到你想要的搜索结果了吗?
是的
没有找到

Redis作者谈如何编写系统软件的代码注释

顶顶大名的Redis作者谈如何在Redis这样系统软件上进行代码文档注释,以下是九种注释类型的大意说明: 很长一段时间以来,我一直想在YouTube上发布一段“如何对系统软件文档注释”的新视频,讨论如何进行代码注释,然而,经过一番思考后,我意识到这个主题更适合博客文章。在这篇文章中,我分析了Redis的文档注释,试图对它们进行分类。在此过程中,我试图说明为什么编写注释对于生成良好的代码是至关重要,从长远来看,这些代码是可维护的,并且在修改和调试期间可由其他人和作者自己理解。 并不是每个人都这么想,许多人认为,如果代码足够扎实,代码具有自明性,无需文档注释了。这个想法前提是,需要一切都设计得很完美,代码本身会有文档注释的作用,因此再加上代码注释是多余的。 我不同意这个观点有两个主要原因: 1. 许多注释并不是解释代码的作用,而是解释*为什么*代码执行这个操作,或者为什么它正在做一些清晰的事情,但却不是感觉更自然的事情?注释是解释一些你无法理解的东西。(banq注:根据海德格尔存在主义哲学观点,注释是解释代码的存在意义,如果注释时说明代码作用,那是在说明代码的存在方式,代码的功能作用是代码的存在方式,不是存在意义,存在意义与编写者动机和阅读者的理解有关,与其上下文场景有关) 2.虽然一行一行地记录代码做些什么通常没有用,因为通过阅读代码本身也是可以理解的,编写可读代码的关键目标是减少工作量和细节数量。但是应该考虑其他阅读者在阅读一些代码时他们的思考角度和进入门槛的难易程度。因此,对我而言,文档注释可以成为降低阅读者认知负担的工具。 以下代码片段是上面第二点的一个很好的例子。请注意,此博客文章中的所有代码段都是从Redis源代码中获取的。

06
领券