码农知识堂 - 1000bd
  •   Python
  •   PHP
  •   JS/TS
  •   JAVA
  •   C/C++
  •   C#
  •   GO
  •   Kotlin
  •   Swift
  • 到底要不要写注释?


    注释是个好东西,但是也要分场合。

    对于我来说,我自己可以不写注释,因为我自己看得懂,但是你必须要写,你不写我看不懂。

    一连串的哈哈哈哈!!

    第一,亲身经历

            我们都应该明白,去工作自己写的代码根本不多,都是去维护公司以前的项目代码。

            那么对于新接触的项目代码怎么快速了解呢?最简单的就是看注释了,所以有一个好的注释习惯对于别人来说是事半功倍的。

            至今,我已经毕业一年多了,工作也差不多一年了。

            我刚来到这个公司的时候,那代码我是真的看不懂,也不知道是什么意思,完全就是自己猜测着来的,好在变量命名还是英文的,不是那种a,b,c,d之类的。

            由于是公司的项目代码,不便粘贴出来,以前那垃圾代码就不给大家见笑了。

            说到注释了,那么对于变量命名也要易于理解,用对应的英文去命名,即使是拼音也好,它起到的意义和注释是一般无二的。

            由于老工程师写的项目代码没有注释,写的也不标准,我光看代码理解看了快一个月,看到头都大了,然后自己看着,猜着,自己逐步注释下来。我刚来,老工程师就辞职了,连个交接都没有,所以没有注释是真的难受。

    第二,不写注释的原因

            我觉得不写注释的原因完全就是因为嫌麻烦,还有就是自己写的代码自己明白是什么意思,觉得没必要写。如果问我,我还会说:我英语不好,笑死有没有。这是为什么呢?因为写的中文注释,在不同的编码下会出现乱码,看起来很难受,但又英语不好,我就想不想注释,反正我每次写注释都是翻译着写的。

    第三,写并且如何写出好的注释

            不要长篇大论的写,关键的地方点睛一下即可。

            变量命名规范,根据名字就可以看懂它的意思。

            我一般喜欢在定义变量的时候加一下注释。

            总之,注释要写,但是写不写还是看自己。就像别人说的,在一个公司里,我不写注释它离不开我。

  • 相关阅读:
    html大作业【NBA篮球介绍 22个页面】学生网页设计源码
    SpringBoot整合MySQL和Druid
    Vue框架之自定义钩子函数,nextTick,局部和全局,什么叫组件?什么是复用?,注册组件需要主要的点注册组件的属性,Css样式的覆盖解决
    【问题记录】解决Git上传文件到GitHub时收到 “GH001: Large files detected” 错误信息!
    IMX6ULL —— 字符编码方式和实现
    数据结构学习系列之顺序表的查找与排序以及去重
    git 给分支添加描述
    Twitter账号优化:吸引更多关注与互动
    【二分图染色】ARC 165 C
    计算机硬件基础
  • 原文地址:https://blog.csdn.net/qq_45796666/article/details/133708673
  • 最新文章
  • 攻防演习之三天拿下官网站群
    数据安全治理学习——前期安全规划和安全管理体系建设
    企业安全 | 企业内一次钓鱼演练准备过程
    内网渗透测试 | 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号