搜索mattrwallace / exegesis
Exegesis：为PHP提供简单注释
Requires
- php: >=5.4.6
- ext-reflection: *
Requires (Dev)
- phpunit/phpunit: 3.7.18
This package is not auto-updated.
Last update: 2024-09-14 14:21:16 UTC
README
简介
Exegesis是在PHP 5中提供的现有Reflection类周围的一个简单包装，允许从文档块中解析注释，然后可以在您的程序中使用这些注释。
目前除了 ReflectionZendExtension 和 ReflectionExtension 以外，所有类都有包装。这些注释类应该对您在Reflection类上调用任何方法都能有预期的响应。
用法
注释可以是未引用的字符串或JSON对象。就像任何其他注释一样，使用 '@' 符号表示注释名称。
解析器足够智能，可以处理硬编码的换行，并返回单个字符串或数组。这的一个副作用是，您希望不解析为注释的任何注释都应该在第一个注释之前写入，否则将被认为是前一个注释的一部分。
待办事项：需要在此处添加有用的示例。
黑名单
存在一种内置机制来忽略由其他框架或实用程序解析的注释，以及一种机制来添加您可能出于任何原因想要忽略的其他项目。目前，可用的内置列表只有phpdocumentor的注释。然而，在未来，我打算添加其他工具（如Doctrine）的列表，这些工具被广泛使用，因此您不必手动添加每个单独的注释。有关黑名单的更多信息，请参阅解析器的文档。
自定义解析器
如果解析器的功能不能满足您的需求，您可以定义自己的解析器（从头开始或使用包含的解析器作为模板）。有关如何操作的详细信息也可在文档中找到。
许可
Exegesis在MIT许可下发布，可在github（MattRWallace/Exegesis）上找到。我鼓励您分叉我并改进我所开始的工作，或者让我知道您使用我的代码可能实现的（希望）了不起的事情。
版权 (c) 2012 Matt Wallace (matthew.wallace@ieee.org)
在此特此授予任何获得本软件及其相关文档文件（以下简称“软件”）副本的人免费使用该软件的权利，不受限制地处理该软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本，并允许向软件提供的人这样做，前提是遵守以下条件
上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。
本软件按“原样”提供，不提供任何明示或暗示的保证，包括但不限于适销性、特定用途适用性和非侵权性保证。在任何情况下，作者或版权所有者均不对任何索赔、损害或其他责任（无论基于合同、侵权或其他方式）承担责任，这些索赔、损害或其他责任源于、产生于或与软件或软件的使用或其他交易有关。