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