README

概览

欢迎！src-run/cocoa-var-dumper-library 包提供了以下功能

一个简单的变量 var-dumper/transformer 库，封装了 symfony/var-dumper 组件。

分组

我们使用 Willy Wonka 启发的命名方案为我们的包分组命名。本包属于 cocoa 组，这是一个以“从给定输入转换、生成新输出”和相关功能为重点的包集合。

如果您手头有太多时间，欢迎研究一些 无用的细节 关于这个特定组。

JTT

本包代表了一个在 大量开源代码 集合中的单个项目，这些代码在 "SR" 命名空间下发布，包括许多框架无关的库、一组 Symfony 扩展包以及一些独立发布。本项目由

• Rob Frawley 2nd
• 合作者

快速入门

安装

通过 Composer CLI 明确要求获取代码，或者通过编辑您的 composer.json 文件来反映依赖项并更新您的项目要求。例如，要通过 CLI 明确要求此项目，请使用以下命令。

$ composer require src-run/cocoa-var-dumper-library

或者，要将此项目添加到您的 "composer.json" 文件中，请将以下内容添加到 "require" 部分。

require: {
	"src-run/cocoa-var-dumper-library": "dev-master"
}

注意：不建议使用 "dev-master" 约束。请意识到，这样做可能会允许拉入具有向后不兼容性、破坏性更改的发布。相反，使用语义版本控制并明确要求是一个好的实践。例如，要要求版本 1.0，您将使用 ^1.0。

参考

API 文档

本包的 API 参考文档可在我们的文档网站上找到（见下方 "附加链接" 部分中的表格 "参考" 行）。所有 API 文档都会在每次发生 git push 事件时自动编译。

计划为特定版本提供静态 API 参考，并在本包成熟并达到版本 1 里程碑时发布。.

上述 API 参考网站是使用可靠的、发展良好的 CLI 工具 Sami 自动生成的。它经过严格和定期的测试，并被用于一些大型项目，例如 Symfony 全栈框架 <see: https://src.run/go/symfony-api>，以及一些小型项目，例如 Twig <see: https://src.run/go/twig-api>。请参阅 Sami 的 仓库页面 以研究在您自己的项目中的使用。

示例/教程

目前，除本README文件外（它本身也是从模板生成的），没有其他“人工编写”的文档。待项目稳定、可用人力以及外部用户实际需求后，我们可能会发布一个包含官方文档、教程和额外资源的Read the Docs页面。

贡献

讨论

如果您想进行一般性咨询或讨论一个广泛的话题或想法，可以在Freenode上找到“robfrawley”。他总是乐于讨论语言级别的想法、项目可能的新方向、新兴技术，以及天气。

问题

要报告问题或请求新功能，请使用项目问题跟踪器。在任何错误报告中提供尽可能多的信息。如果您几天内没有收到回复，请随时“ping”该主题（有时GitHub通知电子邮件会丢失）。

代码

在利用这个包的过程中，您创建了额外的功能？太棒了：将其提交到上游！不要犹豫，提交一个pull request！您的想象力以及我们在CONTRIBUTING.md文件中概述的要求是唯一的限制。

许可证

本项目采用MIT许可证，这是一种经FSF和OSI批准，与GPL兼容的宽松免费软件许可证。请参阅随源代码一起分发的LICENSE文件，以获取更多信息。

附加链接