PHP 注释：# vs. //

Posted 2023-02-24

【中文标题】PHP 注释：# vs. //

【英文标题】：PHP comments: # vs. //

【发布时间】：2010-12-28 11:29:49

【问题描述】：

最近我一直在使用 # 而不是 // 在我的代码中执行单行 cmets。但是，我看到大多数人更喜欢//。

是否有特别的理由偏爱他们而不是#？表现？文件重量？有什么事吗？

【问题讨论】：

Support for prefixing comments with # in INI files has been removed 在 php 7 中。可能是 # 评论过时了。最好坚持流行的 //

【参考方案1】：

它们都服务于相同的确切目的：注释掉一些代码。 我更喜欢#，因为它需要 1 个字节。 // 占用 2 个字节。 ;)

【参考方案2】：

我可能会坚持使用//，因为它在 javascript 中是相同的，并且当您编写 PHP 代码时，您的文件中可能也会有一些 JavaScript。 （现在大多数网站都使用 JavaScript。）

这样，无论使用哪种语言，您的 cmets 看起来都一样，并且会稍微提高可读性。

【参考方案3】：

对于单行 cmets，没有明显的技术原因更喜欢 // 而不是 octothorpe（这就是 Zend PHP 5 Certification Study Guide 调用 #），反之亦然。 // 似乎是野外更常见的选择。

【参考方案4】：

我只建议你使用 // 或 /* */。随着程序的增长，您可能希望使用像phpdoc 这样的文档来为您的程序自动生成文档，并且大多数这些文档以及 IDE 将只接受这两个。

【参考方案5】：

您可以使用#，但// 更常见。 这也是PEAR中约定的代码约定。

【参考方案6】：

"//" 对我来说似乎更符合 "/* */" 块 cmets。但除此之外，我没有理由更喜欢其中一个。

【参考方案7】：

IDE 支持可能是一个原因。例如，使用 Eclipse，您可以使用 // 自动注释和取消注释块，但不能使用 #（使用 PHP 插件；Python 插件使用 #）。以这种方式来看，这取决于您和您的协作者使用的 IDE。

【讨论】：

块 cmets 是 /* */ 不是 //.

@lfx: Eclipse 在所选块中的每一行前面加上//

是的，但他说的是自动注释掉，因为 // 更合适，如果 / */ 在块中，则 /* / 有麻烦被注释掉

【参考方案8】：

我认为这只是品味和偏好的问题。 # 作为注释标记源于 shell 脚本，而 // 则回到 C++，因此取决于阅读您的代码的人及其背景，其中一个或另一个可能看起来不熟悉。

【参考方案9】：

我会说，它不会改变一件事；这只是习惯问题：

// 来自 C

，并存在于许多人使用的多种语言中。

# 来自 shell

和 Perl，并没有像 // 那么多的“重要”语言存在——所以使用它的人更少。

为什么这两个都在 PHP 中可用？嗯，PHP 是由同时了解 C、Shell 和 Perl 的人构建的，他们从这些语言中带来了他们喜欢的东西 ;-)

【讨论】：

好吧，让我们保持逻辑：如果您在一年内键入 // 5000 次，如果您使用 # 代替，您将节省一次按键。保存你的关节，不要对无关紧要的事情保持虔诚。否则，您还可以在键盘上设置一个宏（例如：Logitech G910），您可以在其中按一个键并自动打印出 // + 空格。

@Joel - 你不需要按两个键来获得#吗？ ;)

@KrzysztofPrzygoda 不，我的键盘设置为“French Canadian”，所以它只是 TAB 键上方的一个键（没有 CTRL 或 shift）。这太棒了。

我现在正在输入 /** */ 或 /// 一段时间（Doxygen / phpDocumentor 风格）。 IDE 有助于输入这些内容，所以没有理由不这样做。