工作中对于代码注释的思考

以下是自己在日常开发中总结的关于代码注释的个人思考,供大家参考和讨论。
其实时间充裕的情况下,我是乐意重新审视自己的代码,并为其写上夹杂各种名词和术语的看起来很专业的注释的。不过大部分需求中,我是没有足够时间去做这些工作的因为写注释得是在时间足够充裕的前提下,至少在我头脑风暴后还有时间优化代码和检查代码的那种前提下。
直到我落笔时,在写注释的情况下,我对于如何写注释还是很较真的,比如全篇代码如果写了,就必须统一注释的格式,不能这边使用//,另一个文件甚至同一文件中就开始使用功/* */,这是使我无法接受和容忍的,不过这是与我自身“自带强迫症”有关,哈哈,射手座的命却有着处女座的心。这里我想提到就是,注释要格式专业,函数体就要用函数的注释格式,变量常量就要用该用的格式。索马里海盗人数再多也打不过正规军,代码注释要统一格式,要有规矩。
我最初对于代码注释的较真是有些离谱的,就是写了很多注释,我一开始认为的是,写注释就必须事无巨细、面面俱到,以至于我写过注释的代码,一眼看上去,杂乱无章,本来优美的函数体,被我的注释行补的千疮百孔,况且我的vscode使用的主题中,注释还是绿色字体,一眼看上去,本来该是彩虹般的视感,变得绿油油的。不仅视觉上不舒服,另一方面,我寻思着,不能这样干,注释写那么细,等着被毕业呀(这里的思路是网上有段子说代码不能写那么多注释,最好写成只有自己能看懂的“天书”,这样公司在优化自己时,会考虑接替自己的新人的投入成本的,哈哈),当然我自认为自己写的代码还不能抽象到人人都看不懂的地步,我的思考是,过度的写注释,也是对自己的一种不自信和自降身份的意识。技术是高傲有门槛的,代码更是一门独特的艺术。一般项目的代码,我觉得只要不是刚入行的小白,但凡有点开发能力和经验,融入和吸收代码的成本都是相对较低的,只要在关键节点和代码块上写上必要的注释即可贯穿全篇代码的逻辑,所以,我想说的是,注释要关注要点,就像摄影时要有焦点,那样照片会模糊一片。
三百六十行,行行都是自己行业内的专业术语的。就拿前端开发来说,“渲染”、“组件”、“状态”、“样式”等等这些词汇,在开发日常的交流中还是要经常用起来的。放到代码注释里,同样如此。前面提到注释要关注要点,在关注要点的情况下,针对难点要点关键点的注解内容更是要简洁明了、一语中的。就前端开发而言,比如“把数组中的某对象中的一个元素处理后重新赋值,返回新的数据”换成“返回更新xxxx后的数据”这样就不错,这样已经能够作为注释承接代码上下文来说明函数的功能了。总结了下就是注释要言简意赅,不要又细又长,那样会显得冗余且没必要。
活不多说,先写这么多。其实我这里说的也只是自己的总结,再淦个几年回来看这篇文章,我可能会评论个“注释个锤子啊,早点下班要紧……”,哈哈。

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
校园悬赏任务平台对字典管理、论坛管理、任务资讯任务资讯公告管理、接取用户管理、任务管理、任务咨询管理、任务收藏管理、任务评价管理、任务订单管理、发布用户管理、管理员管理等进行集化处理。经过前面自己查阅的网络知识,加上自己在学校课堂上学习的知识,决定开发系统选择小程序模式这种高效率的模式完成系统功能开发。这种模式让操作员基于浏览器的方式进行网站访问,采用的主流的Java语言这种面向对象的语言进行校园悬赏任务平台程序的开发,在数据库的选择上面,选择功能强大的Mysql数据库进行数据的存放操作。校园悬赏任务平台的开发让用户查看任务信息变得容易,让管理员高效管理任务信息。 校园悬赏任务平台具有管理员角色,用户角色,这几个操作权限。 校园悬赏任务平台针对管理员设置的功能有:添加并管理各种类型信息,管理用户账户信息,管理任务信息,管理任务资讯公告信息等内容。 校园悬赏任务平台针对用户设置的功能有:查看并修改个人信息,查看任务信息,查看任务资讯公告信息等内容。 系统登录功能是程序必不可少的功能,在登录页面必填的数据有两项,一项就是账号,另一项数据就是密码,当管理员正确填写并提交这二者数据之后,管理员就可以进入系统后台功能操作区。项目管理页面提供的功能操作有:查看任务,删除任务操作,新增任务操作,修改任务操作。任务资讯公告信息管理页面提供的功能操作有:新增任务资讯公告,修改任务资讯公告,删除任务资讯公告操作。任务资讯公告类型管理页面显示所有任务资讯公告类型,在此页面既可以让管理员添加新的任务资讯公告信息类型,也能对已有的任务资讯公告类型信息执行编辑更新,失效的任务资讯公告类型信息也能让管理员快速删除。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值