码农知识堂 - 1000bd
  •   Python
  •   PHP
  •   JS/TS
  •   JAVA
  •   C/C++
  •   C#
  •   GO
  •   Kotlin
  •   Swift
  • 程序员对代码注释可以说是又爱又恨又双标……怎么看待程序员不写注释这一事件的呢?


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

    需要写注释

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

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

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

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

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

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

    如何才能写出漂亮的注释

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

  • 相关阅读:
    ② 尚品汇的前台开发笔记【尚硅谷】【Vue】
    DM(达梦)数据库和其他数据库(mysql,sqlserver...)表互相迁移
    reuseaddr和reuseport
    shell中的条件控制语句
    2022年申请牛剑入学的IB学霸们的成绩多高?
    js 删除树状图无用数据,如果子级没有数据则删除
    实操新项目丨手把手带你开发疫情防控系统
    docker之设置代理
    uni-app和微信原生小程序的工具请求文件
    面试官:Java中缓冲流真的性能很好吗?我看未必
  • 原文地址:https://blog.csdn.net/cccfire/article/details/133710805
  • 最新文章
  • 攻防演习之三天拿下官网站群
    数据安全治理学习——前期安全规划和安全管理体系建设
    企业安全 | 企业内一次钓鱼演练准备过程
    内网渗透测试 | Kerberos协议及其部分攻击手法
    0day的产生 | 不懂代码的"代码审计"
    安装scrcpy-client模块av模块异常,环境问题解决方案
    leetcode hot100【LeetCode 279. 完全平方数】java实现
    OpenWrt下安装Mosquitto
    AnatoMask论文汇总
    【AI日记】24.11.01 LangChain、openai api和github copilot
  • 热门文章
  • 十款代码表白小特效 一个比一个浪漫 赶紧收藏起来吧!!!
    奉劝各位学弟学妹们,该打造你的技术影响力了!
    五年了,我在 CSDN 的两个一百万。
    Java俄罗斯方块,老程序员花了一个周末,连接中学年代!
    面试官都震惊,你这网络基础可以啊!
    你真的会用百度吗?我不信 — 那些不为人知的搜索引擎语法
    心情不好的时候,用 Python 画棵樱花树送给自己吧
    通宵一晚做出来的一款类似CS的第一人称射击游戏Demo!原来做游戏也不是很难,连憨憨学妹都学会了!
    13 万字 C 语言从入门到精通保姆级教程2021 年版
    10行代码集2000张美女图,Python爬虫120例,再上征途
Copyright © 2022 侵权请联系2656653265@qq.com    京ICP备2022015340号-1
正则表达式工具 cron表达式工具 密码生成工具

京公网安备 11010502049817号