/资讯中心/网贷源码/p2p源码注释

p2p源码注释

发布时间:2015-08-25 分类:网贷源码

p2p源码注释

p2p源码注释(图片来源互联网)

在看一些源码的时候会经常看到一些注释,然而有些注释是必要的,有些是多余的,那么在p2p源码中如何注释?

·不要每一行p2p源码都注释

如果每一行都注释,会让代码变得冗余,并且每一行都写注释会浪费时间。不要为了注释而注释。

·同一行注释不要太长

在网站设计的时候,会经常遇到界面不够的情况,这时候经常都是用竖着的滚动条,不用水平、横着的,代码也是如此,同一行注释太长,滚动条就是横着拖动了,感觉令人发指。如果觉的注释很长,可以考虑放在p2p源码的上方。

·可以把思路写进去

可以把编写p2p源码的思路写到注释中,后续的维护工作会更好做一些。

·修改源代码也要修改相应的注释

在后面的源代码修改中,不要忘记修改相应的注释,或许在后面还会修改、用到这段代码,如果按照刚开始的注释,那么肯定就是错误的。

注释对p2p源码应该是有用的,应该是对它的一个补充,不能为了注释而注释,应该为了“为什么”而注释。

标签: p2p源码