如何看待程序员不写注释?

如何看待程序员不写注释?

本着严以律人,宽以待己的原则。对于不写注释的程序员,我认为必须判死刑,死刑,必须的是死刑。而且不能单纯的敷衍随便写写,必须秉着一丝不苟严谨的态度写,必须写注释,而且还得写好注释。

什么?你问我写不写注释?
那我肯定写是写,写的不能太多,只能写一点点。( ̄︶ ̄)↗

玩笑归玩笑,注释还是要写的。

一般来说,咱们程序员写代码的时候其实大部分时间是在看代码,时不时敲一下键盘。
写代码的过程大部分时间其实是在看代码,所以代码的可读性好的话,写代码绝对是能起到加速的效果的。

那么问题来了,如何写好注释呢?

既然不知道答案,那咱们就来问一问chatgpt


  1. 清晰而简洁:注释应该简洁明了,不要写冗长的注释。避免使用不必要的技术术语和专业术语。
  2. 解释代码的意图:注释应该解释代码的目的和意图,而不仅仅是描述代码在做什么。为什么要这么做,对于未来的开发人员来说更有帮助。
  3. 避免重复:不要写与代码相同的注释,这只会浪费空间并使注释失去意义。注释应该提供额外的信息,而不是重复已有的信息。
  4. 及时更新:当代码发生更改时,确保相应的注释也被更新,以保持注释与代码的一致性。
  5. 注释复杂的算法:如果您编写了复杂的算法或有意义的数学操作,请提供详细的注释以解释其工作原理。
  6. 标记临时解决方案:如果您在代码中使用了临时解决方案或计划将来改进,请明确注明,以免其他人误解。
  7. 文档化函数和方法:对于每个函数或方法,提供说明其参数、返回值和行为的注释。
  8. 使用注释模板:在您的团队中定义一致的注释模板,以确保注释的一致性和可读性。
  9. 避免不必要的注释:不要在代码中添加不必要的注释,这会让代码变得混乱。只在需要解释或澄清时添加注释。
  10. 检查拼写和语法:确保您的注释没有拼写错误或语法错误,以保持注释的专业性。
  11. 使用自然语言:尽量使用自然语言编写注释,以使其更易理解。避免使用过多的编程术语。
  12. 考虑可维护性:在注释中提供关于如何维护代码的建议,例如添加新功能或修复错误。
  13. 不要留下无用的注释:删除不再需要的注释,以保持代码库的整洁。

如何看待程序员不写注释?_第1张图片

你可能感兴趣的:(学习)