避免注释

普通人如何写注释

通常我们在编写代码时添加注释,页面开头和方法前以及代码语句中。
这其中我们有时候会经常见到类似于下面的注释

//edit by hello 2015.08.27

还有这种注释代码的类型

/*
    $name = 'Hello';
    ...
*/

像这种直接注释掉代码块的方式,在之后的项目更新和重构的时候经常会有人看到这些不知所措,到底是删除掉还是留着,让人陷入迷茫。

以上两种类型其实都是版本控制的工作。我们只需要该去掉的去掉,让版本控制去记录这一切就好。

为什么写注释

写注释首先是为了能够在代码无法表达你的工作的时候通过注释能够让自己和后来的人能够快速的了解你此段代码的含义是做什么工作用的。减少对代码理解的时间。其次还有就是通过注释表明添加人和更改人。需要的时候能够快速的找到负责人。

为什么不写注释

不是说完全不写注释,而是要少些注释,在一些完全不需要对外展示的方法中并且你的方法命名完全能看懂该方法所做的事情时完全不需要添加注释。

而是在一些复杂的方法一些方法名已经无法表达你所要做的事情的含义的时候。这个时候需要写注释。

有些注释是很有必要的
* 警告,在文件头或者函数中注明非常重要的事情
* todo,现代IDE能发现项目中所有的todo注释,要经常清理才有意义
* 法律信息

最后,我想说的是,一个好的方法名其实就是最好的注释。所以尽管有些时候我们需要注释,但我们应该多花一些心思减少注释。

本文内容观点出自作者本身,如有其他观点,可以在文章下留言。一起讨论

发表评论

发表评论

*

沙发空缺中,还不快抢~