Как вы комментируете HTML-шаблоны в Php (на практике)?

Question

Есть ли простое решение, чтобы сделать эквивалент комментариев Java:

<%-- this is a comment inside a template, it does not appear in the output HTML --%>

Даже если вы используете короткие теги php, вам все равно придется обернуть комментарии синтаксисом комментариев поверх тегов php:

<? /* this is a comment of the html template */ ?>

Я подумываю сделать какой-то фильтр для шаблонов вывода, чтобы удалить все html-комментарии или, что еще лучше, пользовательские комментарии, такие как синтаксис Java выше, но как бы вы сделали это наиболее эффективным способом? Вы должны запустить регулярное выражение, верно?

Причина моего вопроса заключается в том, что во фреймворке MVC, с использованием компонентов и повторно используемых HTML-шаблонов (например, YUI), мне необходимо четко документировать эти шаблоны в удобочитаемой форме.

Answer 1

Не знаю, но короткий тег и комментарии к блоку очень просты - их так же легко набрать, как и комментарии JSP, которые вы упомянули выше:

<?/* This is a comment */?>

или даже

<?// this is a comment ?>

В более сложных системах шаблонов PHP, таких как Smarty, существуют другие синтаксисы.

Answer 2

Я просто добавлю свои 2 цента за это о вашей короткой метке.

Вам нужно будет тщательно обдумать это, прежде чем ваши комментарии будут окружены вашими шаблонами. Короткий тег не поддерживается везде, он не является чем-то стандартным. Это полезно, но, скорее всего, вызовет проблемы.

Поэтому обязательно используйте полный тег php (

Answer 3

, если вы действительно хотите / должны использовать обычный php для шаблонизации

    <?# this seems the best way to do comments ?>
    <?/* but
         block comments
         look ugly IMHO */?>

Но я думаю, что есть большая концептуальная разница между PHP и JSP - не в сценариях использования в реальном мире, а в том, для чего они были созданы / разработаны.

Хотя JSP был явно создан для того, чтобы быть частью «представления» или «представления» веб-приложения java с минимально возможной управляющей логикой, PHP начинал как нечто вроде Perl, но гораздо более сфокусированное на веб-разработке.

Таким образом, ваш usecase (повторно используемая MVC-инфраструктура), кажется, требует одного из отдельных языков шаблонов для PHP, таких как Smarty или PHPTAL , которые лучше подходят для отдельной презентации из логики, чем простой PHP. Таким образом, вы будете использовать PHP для частей модели, контроллера и языка шаблонов, как если бы вы использовали JSP (и да, большинство шаблонизаторов поддерживают комментирование шаблонов / блоков шаблонов гораздо лучше, чем PHP).

С уважением

Argelbargel

Answer 4

Триптих подходит для тегов php. снаружи, <!-- Comment here --> все еще работает.

Answer 5

Разве это не должно работать?

<? # This is a comment ?>
<? // This is a comment too ?>

Это не слишком многословно, не так ли?