使用PHP注释'干净'代码

时间:2014-01-13 14:59:38

标签: php html coding-style comments

我喜欢在我的代码中留下评论,以便其他人可以更轻松地理解我的代码。但是,我不喜欢HTML评论,因为我不喜欢我的代码中的<!-- comment -->

我知道他们发表评论并且他们不会被页面阅读,但我不喜欢在源代码中使用它们,而只是偏好页面中的代码。 (我认为这是一种奇怪的强迫症,而非实际的偏好,它只是感觉不对。)

所以我一直在做<?//This is my comment?>。我知道这是一种愚蠢的方式,但它只出现在我的代码而不是源代码中。 (我只在PHP页面上执行此操作,如果不需要PHP,我会将其删除并使用<!-- comment -->

但问题是:如何清洁&#39;正在使用 <?//comment?> 在代码中插入评论?

使用这样的评论有什么缺点,这样使用它们有什么技术上的错误吗?

我知道这个问题可以被视为基于意见的问题,但我想知道技术上的缺点而不是个人的。我也知道长手PHP标签,但我的服务器允许它们。我还要用长手吗?

1 个答案:

答案 0 :(得分:2)

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

在我看来,担心现在做类似事情的性能问题是愚蠢的,但我想如果你像Google一样大,你甚至可以确保你的HTML类名尽可能短,以使源更小。

关于清洁度 - 它和您或其他阅读代码的人一样清晰。如果你和你的同事都没有反对他们,那么继续使用它们。如果你有前端开发者抱怨这样的东西,那么我建议你看看像Twig这样的东西。

Twig允许您使用PHP之类的内联注释以及本机HTML注释:

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

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

此外,您实际上可能会遇到与CSS相同的问题,其中某些人可能不喜欢留下评论以供其他人查看。

如果是这种情况,你可以查看LESS,这可以让你做同样的事情:

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

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

如果你最小化你应该做的样式表,那不是问题。在输出之前你也可以使用HTML做什么! :)