程序员对代码注释可以说是又爱又恨又双标……怎么看待程序员不写注释这一事件的呢?

程序员对代码注释可以说是又爱又恨又双标……怎么看待程序员不写注释这一事件的呢?

需要写注释

写注释可以对代码的解释、说明和文档,帮助他人(包括自己)理解代码的意图和实现。因此,编写注释是一项良好的编程实践,可以提高代码的可读性和可维护性,好地组织思路、记录设计决策和代码逻辑,以及在以后的时间里更容易回顾和修改代码。注释可以作为自己的备忘录,帮助自己更好地理解代码的目的和实现。

不写注释会带来什么影响?

对于别人写代码不写注释的情况,这可能会导致其他人在阅读和理解代码时遇到困难。没有注释的代码可能需要花费更多的时间和精力来理解其功能和实现细节。因此,许多开发者认为在编写代码时应该添加适当的注释,以便于团队合作和代码维护

但是不写注释的原因是什么呢?

有些人认为过多或无效的注释可能会增加代码的冗余,并且在代码发生变更时,注释可能会与实际代码不一致,导致混淆。

还有些人认为,shi山只能自己能看懂,别人看懂了自己的价值就没了。哈哈

如何才能写出漂亮的注释

我认为好的注释,不需要长篇大论,只需简短的介绍代码的基本逻辑,并且实现和代码保持一致就行了,总之注释在代码中的使用是一个权衡和取舍的问题。在编写代码时,应该根据实际情况和团队的要求,合理地添加注释,以提高代码的可读性和可维护性。

你可能感兴趣的:(源代码管理)