知道不?用PHP编程时,注释特有用,让代码更好理解,也更好修!今天咱就来说说这事儿,教你怎么巧妙地用单行注释和多行注释,让你的技术飞速进步
一、单行注释
这就是老话说的“塞翁失马,焉知非福”,比如,写单行注释太简单了,就在编码旁加个//就搞定。注释还有个好处,就是能了解这个代码是干嘛的。而且,这种方式完全不影响程序运行,简直就是如鱼得水!我平时编程时,会用单行注释标出重要的变量、函数,甚至解释某个功能怎么实现。
PHP编程时,多加点单行注释更易于阅读!像写函数,给每句话加上注释可以让大家更好地理解你的思路。而且,调试时候加注释也能隐藏不相关的代码,找BUG就容易多了!
二、多行注释
用/**/括起来的大括号注释,覆盖的范围可大了,包括好几行甚至是整个段落的代码都行。相比单行注释,它能放更多字,有时能完全盖住你的程序内容,看代码的时候超级好用!就算删掉部分代码,有了这个注释,结果还是看得清清楚楚的。
只要你编程,注释就是一扇门,帮你遮挡不想要人看到的那些东西,比如让你头大的算法,或者你自己都看不懂的代码。这个时候,注释就显得特别重要了!它不仅能帮你理清思绪,还能告诉你接下来要干啥。而且,就算面对一堆代码,有了注释,你也能快速搞清楚它们都是干嘛的,还有背后的设计想法是啥。
三、单行注释与多行注释的对比
写编程,注释就用”//”,像“//这就是小注释啦”这样的。嫌不够?那就加个”/**/”,能塞很多内容。但其实,大家更爱用单行注释,简单明了;大注释主要是给那些长代码段做说明的。
哥们儿,记住嘞,写PHP时候少点注释哈。长篇大论或太长的注释会让你的代码看起来很杂乱,影响阅读。究竟是单行注释,还是多行注释,这得看实际情况!
四、如何合理运用PHP中的单行和多行注释
函数和算法简单点儿好理解,别绕圈子!注释里换个行就能说清楚的事儿就别麻烦。但是,重要的部分还是多打几个字儿说明白点~
找出BUG神器:遇到问题总要插点DEBUG代码,不过提交前记得把它们删了重要信息千万别被别人看到咯。
3.项目文档:利用多线评论编写项目文档或接口说明文档。
团队团魂:团建要看清现状,守规矩最重要!
记得记录版本的改变!为什么要改也要写清楚。
五、总结
看来你现在能分辨出PHP中的单行和多行评论差别!真是不错!这样会使代码更简短,节省好多时间去干别的事。对团队合作也很有益处!
评论0