php - 多行注释 vs 单行注释

Question

我记得在 JavaScript 教程中读到，通常最好避免使用单行注释，以防将来有人决定要压缩文件并删除所有空格。

在 PHP 中也是如此吗？即使我只占用一行，我是否应该使用多行注释，例如

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

或者在这种情况下使用单行注释可以吗？

PHP 文件是否曾经通过删除空格来压缩过，还是有点极端？

Answer 1

is it fine to use single line comments in such situations?

简短回答:是。
如果有人压缩空格并破坏了您的代码，那是他们没有做对的错。

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

我能想到的避免单行注释的唯一实际原因是，当您往返于 Windows 和 *NIX 服务器时，有时会出现行尾问题。如果您正在使用 Windows 风格的换行符并且您的文件将它们保留在 *NIX 服务器上，那么您的单行注释最终将注释掉您的实际代码，从而搞砸一切。 /* 这样的注释 */ 不会有任何影响。示例:

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

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

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

如果您运行它，您最终可能会执行一些意外的危险代码。

但是:如果发生这种情况，则表明存在另一个无论如何都应该解决的问题。我遇到过几次这种情况，所以我知道这是可能的。许多 FTP 客户端无论如何都会转换换行符。

所以实际上:是的，使用单行注释很好。注释是给作者的，而不是编译器或解析器的。