PHP - 从评论中获取元数据的最佳方式
PHP - Best way to get meta data from comments
PHP 有一个名为 get_meta_tags 的函数,它可以读取 HTML 个文件的元标记。但是,据我所知,没有标准方法可以为 PHP 文件定义元标记。事实上的解决方案似乎是在文件顶部添加注释,如下所示:
<?php
# Author: Ood
# Description: Hello World
?>
有没有什么方法可以使用 PHP 读取这些“元标记”,类似于 get_meta_tags
使用默认 PHP 库的方式?最好不要使用 file_get_contents
后跟正则表达式来解析整个文件以获得最佳性能。如果没有,也许有人知道将元数据功能添加到 PHP 文件的更好解决方案。提前致谢!
在我们的项目中,我们对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采用的标准JavaDoc
感到满意。
在我们的采用中,我们使用第一个 multi-line 注释,即 /**
和结束标记 */
之间的任何注释,使用 JavaDoc 样式来描述有关当前脚本的所有细节.
因此,要在我们的项目中采用您的示例,我们将采用以下语法:
<?php
/**
* @author Ood
* @desc Hello World
*/
当然,您的自定义函数最终可能会读取 php 文件的开头,仅解析第一个 multi-line 注释以获取脚本描述,即元标记。
PHP 有一个名为 get_meta_tags 的函数,它可以读取 HTML 个文件的元标记。但是,据我所知,没有标准方法可以为 PHP 文件定义元标记。事实上的解决方案似乎是在文件顶部添加注释,如下所示:
<?php
# Author: Ood
# Description: Hello World
?>
有没有什么方法可以使用 PHP 读取这些“元标记”,类似于 get_meta_tags
使用默认 PHP 库的方式?最好不要使用 file_get_contents
后跟正则表达式来解析整个文件以获得最佳性能。如果没有,也许有人知道将元数据功能添加到 PHP 文件的更好解决方案。提前致谢!
在我们的项目中,我们对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采用的标准JavaDoc
感到满意。
在我们的采用中,我们使用第一个 multi-line 注释,即 /**
和结束标记 */
之间的任何注释,使用 JavaDoc 样式来描述有关当前脚本的所有细节.
因此,要在我们的项目中采用您的示例,我们将采用以下语法:
<?php
/**
* @author Ood
* @desc Hello World
*/
当然,您的自定义函数最终可能会读取 php 文件的开头,仅解析第一个 multi-line 注释以获取脚本描述,即元标记。