关于：为什么要写注释----谈一下个人体会

注释：

好的代码应该像一本好书，读起来不仅让人涨知识，还能让人心情愉悦，而不应该像一坨shit,让维护和开发的人急于想要把它丢给别人。

1.要素

关键位置需要写注释，代码注释三要素：

*是什么、为什么、干什么

*好的注释应该自成体系，不应该点击跳转到其他界面才知道是什么。。。

*注释不仅是对代码的说明，更是对项目逻辑的梳理，把步骤写明之后，就可以填鸭式的编写代码。

2.规范

代码的编写应该规范，该原则应该排在优雅性易读性原则之前，是最重要的原则。

还是那句话：规范具有通用性，即使该方法很笨，很不优雅，而不同的编程语言对优雅性和易读性却有不同的要求。

模块化虽然更加清晰简洁，但是会降低第三方阅读的逻辑性。。

3.为什么写注释

自己的代码很熟悉了，为什么还要多写注释？

注释其实可以是对自己代码思路的整理，我们平时没时间整理，那就可以写在代码里，以方便以后在技术周报或者其他地方使用，还可以总结自己的技术点，对于平时没时间或者用过就忘的我们来说是非常重要的。

4.注释量大小

优秀的代码的注释量会有三分之一甚至达到二分之一。这个可以参考各个大厂SDK的使用说明，大量的注释是代码模块化的基础，可以在不同的程序员间无障碍使用，基本不会有离职后项目就无法开发的问题。建议建立公司代码库

关于：为什么要写注释----谈一下个人体会相关推荐

讨厌别人不写注释，但自己也不爱写？那么试试这个IDEA的注释插件吧！
平时大家编程时,有没有养成良好的注释习惯呢?一个好的注释习惯对于代码的回溯.重构,或者对于他人解读,都有着莫大的帮助,但是大家编码的时候有没有觉得写注释会稍稍的让编码慢下来一点呢?如果有个工具,可以帮 ...
自解释的代码根本不存在，老老实实写注释吧
作者 | Sven Gregori 译者 | 薛命灯有什么比花时间写注释更令人感到兴奋的事情吗?如果我没有猜错,你可能会说:"不好意思,所有事情都比写注释更令人感到兴奋".如果有 ...
反思代码能力提升点：foreach循环层数；命名契合；分块写；写注释；分步骤；多沟通
1.foreach循环最好不要超过四层超过四层之后之后再看容易看晕分开写循环尽可能的简化扩展性也好一些 2.命名一定要考虑好还是很重要的最好名字的意思与其他的变量能够立马 ...
代码自解释不是不写注释的理由
有什么比花时间写注释更令人感到兴奋的事情吗?如果我没有猜错,你可能会说:"不好意思,所有事情都比写注释更令人感到兴奋".如果有人要你给代码加上注释,对你来说就像是一种侮辱.你的代码 ...
[react] 在JSX中如何写注释？
[react] 在JSX中如何写注释? {/* A JSX comment */} 个人简介我是歌谣,欢迎和大家一起交流前后端知识.放弃很容易, 但坚持一定很酷.欢迎大家一起讨论主目录与歌谣一起 ...
低级程序员才喜欢写注释！
作者 | Tameem Iftikhar 译者 | 平川策划 | Tina 我并不是提倡不写代码注释,只是建议不要过于依赖注释,这样可以使代码更干净.更有表现力,这也能提高开发人员的水平.我自己也在 ...
优秀的程序员真的不写注释吗？ | 原力计划
作者 | 沉默王二责编 | 王晓曼出品 | CSDN博客前言我在很多地方看到这样一个观点,"请停止写注释,因为只有烂的代码才需要注释."这个观点非常巧妙,它让我想起了孟子的 ...
Mybatis - xml文件标签中写注释
Mybatis - xml文件标签中写注释 1.错误场景. ( /* */ 注释 ) 在IDEA中的直接使用快捷键注释 Ctrl + Shift + / 注释. SELECT t.name, t.ag ...
程序员写代码要写注释吗？写你就输了
前言:在职业发展道路上,需要不断提升自己,需要学习资源的,一起学习交流的欢迎加群[443128517],小编准备了学习视频,学习线路,自学书籍,职业发展视频.也可以加美女老师七七的微信.二维码放在下面 ...
“穷X”事件程序员致歉：以后老实写代码，正紧写注释
(点击上方公众号,可快速关注) 转自:新浪科技 tech.sina.com.cn/i/2017-11-20/doc-ifynwnty5776053.shtml 新浪科技讯 19日晚间,技术论坛出现了 ...

关于：为什么要写注释----谈一下个人体会

关于：为什么要写注释----谈一下个人体会相关推荐

最新文章

热门文章

关于： 为什么要写注释----谈一下个人体会

关于： 为什么要写注释----谈一下个人体会相关推荐

最新文章

热门文章

关于：为什么要写注释----谈一下个人体会

关于：为什么要写注释----谈一下个人体会相关推荐