• 程序员开发过程中还是需要写注释的


    简单说明:关于注释的问题,一直以来都是两面派,一方面认为在快速迭代的开发过程中,添加注释会浪费很多程序员自己的时间,从而影响开发进度,被问责被丢锅...另一方面认为,注释作为开发功能的赘述,不管是对于leader的review还是对于后面维护的人员,都是很友好的行为。

    详细论述:代码注释可以帮助其他开发人员更好地理解代码的功能和实现方式,也可以帮助自己更好地维护和修改代码。如果代码没有注释,那么其他人在阅读代码时可能会遇到很多困难,也会增加代码维护的难度。当然,写注释也需要注意适度。过多的注释可能会让代码变得冗长,而且如果注释和代码不一致,反而会给其他开发人员带来困惑。因此,我们需要在写注释时把握好度,注释必须准确、简洁、清晰,能够帮助其他人更好地理解代码。

    通俗理解:首先在项目开发过程中,总是会经历多人开发的,快速的上手是很关键的一环,所以对于有注释的代码,不论是从业务角度还是技术角度,都可以让接手的人快速进入状态。其次,对于复杂功能,不论是自己还是他人,都会随着时间的流逝,将当时开发的状态逐渐丢失,导致功能迭代时,有一部分时间浪费在捋清当时的逻辑,影响开发效率。最后,作为开发规范来说,必要的注释还是需要的,比如说方法上,特定属性上等等。。。

    (大厂也有注释的开发规范,不写注释容易在大厂被优化噢)

    如何才能写出漂亮的注释

    写出漂亮的注释需要注意以下几点:

    1. 注释要简洁明了,不要过于冗长,避免出现过多的废话。

    2. 注释要准确描述代码的功能和作用,不要出现歧义或误导。

    3. 注释要符合语法规范,遵循一定的格式和排版,使其易于阅读和理解。

    4. 注释要避免出现拼写错误和语法错误,这会影响代码的可读性和可维护性。

    5. 注释要避免出现过多的技术术语和缩写,这会增加阅读难度。

    6. 注释要避免出现与代码不一致的信息,这会导致混淆和错误。

    7. 注释要避免出现与代码重复的信息,这会浪费空间和降低可读性。

    8. 注释要遵循一定的规范和约定,使其易于维护和更新。

    总之,写出漂亮的注释需要注重语言表达和排版格式,同时要注意注释的准确性和一致性,这样才能使注释更加易于阅读和理解。

    总之,写注释是一种良好的编程习惯,可以提高代码的可读性和可维护性,也是一种对其他开发人员的尊重和负责任的态度。

  • 相关阅读:
    基于 Redisson 和 Kafka 的延迟队列设计方案
    【前后缀统计】238. 除自身以外数组的乘积
    win7上安装microsoft edge浏览器, 模拟ie11模式
    jdbc不能使用占位符代表表名及其解决方法
    内网渗透-内网环境下的横向移动总结
    生活随笔:沉淀的重要性
    基于单片机的多功能电子万年历系统
    Java中如何借助InputStream写入文件及保存文件呢?
    遥感云计算的一个拐点
    防火墙原理讲解(二)
  • 原文地址:https://blog.csdn.net/CodersCoder/article/details/133783413