PHP - 从评论中获取元数据的最佳方式
PHP 有一个名为 get_meta_tags 的函数,它可以读取元数据HTML 文件的标签。然而,据我所知,没有标准的方法来定义 PHP 文件的元标记。事实上的解决方案似乎是在文件顶部添加注释,如下所示:
<?php
# Author: Ood
# Description: Hello World
?>
有没有办法用 PHP 读取这些“元标记”,类似于使用默认 PHP 库的 get_meta_tags
工作方式?最好不要使用 file_get_contents
解析整个文件,后跟正则表达式以获得最佳性能。如果没有,也许有人知道更好的解决方案来向 PHP 文件添加元数据功能。提前致谢!
PHP has a function called get_meta_tags which can read meta tags of HTML files. However, as far as I know there is no standard way to define meta tags for PHP files. The de facto solution seems to be to add comment to the top of the file like so:
<?php
# Author: Ood
# Description: Hello World
?>
Is there any way to read these "meta tags" with PHP similar to the way get_meta_tags
works using the default PHP library? Preferably without parsing the entire file with file_get_contents
followed by a regex for best performance. If not, maybe someone knows of a better solution to add meta data capabilities to PHP files. Thanks in advance!
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(1)
在我们的项目中,我们对 PHPDoc 使用
@field
语法,您可能从任何 PHP 函数或类定义中知道它。使用 PHPDocumenter 可以很好地阅读。在我们的采用中,我们使用第一个多行注释,即
/**
和结束标记*/
之间的任何内容,使用 JavaDoc 风格来描述有关当前脚本。因此,要在我们的项目中采用您的示例,我们将采用以下语法:
当然,您最终可能会使用自定义函数读取 php 文件的开头,仅解析第一个多行注释以获取脚本描述(又名元标记)。
In our project we are happy with the standard
JavaDoc
that was adopted by PHPDoc using the@field
syntax as you might know it from any PHP function or class definition. This is pretty fine readable using the PHPDocumenter.In our adoption we use the very first multi-line comment, ie anyting between
/**
and closing tag*/
, using the JavaDoc style to describe all the details about the current script.So to adopt your example in our project we would have following syntax:
Of course you may end up with your custom function reading the beginning of the php file parsing just the very first multi-line comment to get the script description aka meta tags.