多行评论与单行评论

Question

我记得在JavaScript教程中读到,通常最好避免使用单行注释,因为将来有人决定要压缩文件并删除所有空白区域.

PHP中的相同环是否正确？我是否应该使用多行注释,即使我只会占用一行,例如

echo $var; /*This code echoes a variable*/ 

或者在这种情况下使用单行评论是否可以？

PHP文件是通过删除空格来压缩的,还是有点极端？

Answer 1

在这种情况下使用单行注释是否可以？

简短回答:是的.
如果有人压缩空白并破坏你的代码,那就是他们做错了就是他们的错.

任何值得使用的 PHP或JS源压缩器应该足够聪明,以便知道要删除什么以及不要触摸什么,并且所有注释通常都会被删除,因此它不是相关问题.你不应该围绕这些事情编码.

我可以想到避免单行注释的唯一实际原因是,当你往返于Windows和*NIX服务器时,有时会出现行结尾的问题.如果你使用的是Windows风格的换行符和文件保留他们一个*NIX的服务器上,您的单行注释将结束注释掉你的实际代码,搞乱一切./* Comments like this */不会影响任何事情.例:

$var = 'Hello'; // Say hello
echo $var;

使用Windows样式\r\n换行符上传到UNIX服务器:

$var = 'Hello'; // Say helloecho $var;

如果你运行它,你最终可能会执行一些非预期的危险代码.

但是:如果发生这种情况,这是另一个应该解决的问题的症状.我已经有几次发生这种情况,所以我知道这是可能的.许多FTP客户端无论如何都会转换换行符.

所以实际上:是的,使用单行注释很好.注释适用于作者,而不是编译器或解析器.