对“干净”代码使用 PHP 注释答案

【问题标题】：Using PHP comments for 'clean' code对“干净”代码使用 PHP 注释
【发布时间】：2014-01-13 14:59:38
【问题描述】：

我喜欢将 cmets 留在我的代码中，以便其他人可以更轻松地理解我的代码。但是，我不喜欢 HTML cmets，因为我不喜欢在我的代码中使用 。

我知道它们是 cmets，页面不会读取它们，但我不喜欢将它们放在源代码中，而只喜欢页面中的代码。（我认为这是一种奇怪的强迫症，而不是实际的偏好，只是感觉不对）。

所以我一直在这样做<?//This is my comment?>。我知道这是一种愚蠢的做法，但它只出现在我的代码中而不是源代码中。（我只在PHP页面上这样做，如果不需要PHP，我就吸干它并使用。

但问题是：“干净”如何使用 <?//comment?> 在代码中插入注释？

像这样使用 cmets 有什么缺点，像这样使用它们在技术上有什么问题吗？

我知道这个问题可以被视为“基于意见”，但我想知道技术上的劣势而不是个人。我也知道长手 PHP 标记，但我的服务器允许它们。我还是要用长手吗？

【问题讨论】：

我能想到的唯一潜在问题是速记 php 标签，因为它们不是 100% 得到服务器支持的。
虽然我认为这个问题主要是基于意见的，但我绝对不会使用简短的开放标签。
@Novocaine88 我使用的服务器确实支持这个，但是还是最好使用长手版本吗？
关于速度：不要过早优化。它将比 HTML cmets 慢，因为 php 标签中的代码必须以某种方式解释，但您不会注意到这一点。
如果你打算使用嵌入式 PHP cmets，我更喜欢使用 <?php /* .... */ ?> 而不是 // 评论，因为 // 使得评论是否应该结束变得模棱两可在?>。

【解决方案1】：

这种方法本身没有技术缺点，我看到的唯一“问题”是解析器必须将 <?php 和 ?> 的内容解析为 PHP，因此需要提取数据并传递将它发送给 PHP 解释器，只是为了让它发现实际上没有要渲染的东西。

在我看来，现在担心执行此类操作的性能问题是愚蠢的，但我想如果您像 Google 一样大，您甚至会确保您的 HTML 类名尽可能短以使源代码更小。

关于清洁度 - 就像您或其他任何阅读代码的人所感知的一样清洁。如果您和您的同事都没有反对他们，请继续使用它们。如果您有前端开发人员抱怨这样的事情，那么我建议您查看Twig 之类的内容。

Twig 允许您拥有像 PHP 这样的内联 cmets 以及原生 HTML cmets：

{# this comment will not be rendered to the user #}
{{ print something }}

<!-- this comment will render as usual -->

此外，您实际上可能会遇到与 CSS 相同的问题，有些人可能不喜欢将 cmets 留给其他人查看。

如果是这种情况，您可以查看LESS，它允许您做同样的事情：

/* this comment will be visible to end users */    
.custom-class {}

// this comment won't...
.other-custom-class {}

如果你最小化你应该做的样式表，这不是问题。在输出之前你也可以用你的 HTML 来做这件事！ :)

【讨论】：

非常感谢您的回复并推荐 Twig 和 LESS。我会接受这个，因为它或多或少地给了我我想知道的东西，谢谢！
很高兴为您提供帮助！附带说明一下，如果您决定使用 Less，这个工具非常好：wearekiss.com/simpless。它监视您告诉它的文件并自动编译它，因此您不必在刷新您所在的页面之前运行任何命令。如果您有多个 less 文件，请创建一个名为 includes.less 的文件并添加 @import file1、@import file2 等，并将工具指向 includes.less 之一。