通过 
搜索
搜索hanneskod / exemplify
2.0.0-beta1
2020-12-25 14:25 UTC
Requires
- php: >=8.0
- amphp/parallel-functions: ^1
- crell/tukio: ^1
- fig/event-dispatcher-util: ^1
- psr/container: ^1
- psr/event-dispatcher: ^1
- symfony/console: ^5
- symfony/dependency-injection: ^5
- symfony/finder: ^5
- symfony/process: ^5
- symfony/yaml: ^5
Requires (Dev)
This package is auto-updated.
Last update: 2020-12-28 13:52:42 UTC
README
验证文档中的PHP代码示例。
此文件描述了版本
2，它使用php8属性。
关于使用docblock样式注释的版本
1，请参阅 此链接。
为什么？
你是否更新了你的库，但忘记更新README中的代码示例？你的用户是否在抱怨示例中的语法错误？你是否觉得手动测试所有示例太麻烦？Readme-Tester 允许你自动化验证文档文件中PHP代码示例的过程。
一个简单的示例
Readme-Tester 使用HTML注释中的php8样式属性（在例如GitHub上渲染后使其不可见）来指定代码示例的预期结果。
以下简单示例断言代码输出内容。
<!--
#[ReadmeTester\ExpectOutput('/foo/')]
-->
```php
echo "foobar";
```
有关更多信息，请 阅读文档。
安装
使用 phive（推荐）
使用 phive 进行安装
phive install hanneskod/readme-tester
作为phar存档
从 发布 标签下载最新的phar存档。
可选地将 readme-tester.phar 重命名为 readme-tester 以获得更流畅的体验。
使用 composer
将其作为 composer 依赖项安装
composer require --dev hanneskod/readme-tester
这将使 readme-tester 在 vendor/bin/readme-tester 中可用。
从源代码
要构建，您需要 make
make sudo make install
构建脚本使用 composer 来处理依赖关系，并使用 phive 来处理构建工具。如果它们没有作为 composer 或 phive 安装，您可以使用类似以下内容：
make COMPOSER_CMD=./composer.phar PHIVE_CMD=./phive.phar
入门
使用命令行工具非常简单
readme-tester README.md
要获取更详细的信息，请使用
readme-tester -h