Hello,大家好!我是你们的鬼哥~~
代码到底要不要注释?这个问题在咱们程序员群体中是存在争议的。
在一些程序员看来代码就是要写注释的,为了让代码更加的可读、更加的易于理解。然而还有一部分程序员是认为代码要写注释则说明代码写的不够清楚,正在清晰的代码是不需要注释的。
在我看来对于注释绝对的写与不写都是不可取的,咱们应该中和起来。
在我团队针对代码注释是有规范的,有些情况必须要写注释。比如说不易理解的算法、项目核心类和字段啥的、很复杂的业务逻辑等等,这些都是必须要注释写明的。
至于其他的常规代码则是把注意力都放在代码的编写上面,把代码写好了再来选择是否要写注释。很多代码都不需要写注释的,一眼就能看明白。
Ps:下面的代码注释里有亮点,出自一款已经停服的知名音乐App源代码。
今天还要给大家分享一个 IDEA 插件:Easy Javadoc,通过这款插件我们可以直接生成 javadoc 的文档注释、翻译你的中文方法名还支持文档翻译。
类、方法和属性注释
鼠标移动到你想要生成注释的类、方法或者是属性上面,然后使用快捷键 ctrl \ 就能自动生成注释。
如果你想要给类批量生成注释文档,只需要使用快捷键 ctrl shift \ 就OK了。
翻译
也可以将你需要注释的方法、类或者是属性翻译,然后再进行注释。并且翻译功能是接入的有道、百度、腾讯等等,不用担心翻译结果不精准。
耗时数月整理出来的技术资源免费分享给大家扫描下方二维码,回复关键字【技术福利】获取!喜欢的这里报道
↘↘↘