README

PHP Glossary 是一款概念性和演示性的软件工具，旨在分析源代码并识别与业务逻辑相关的领域特定术语。该实用程序旨在区分领域术语与通用编程语言关键字，帮助开发者深入了解定义项目特定功能的关键术语。

功能

要将此项目作为现有 PHP 项目的开发依赖项安装，您可以使用带 --dev 标志的 Composer 的 require 命令

composer require --dev javanile/php-glossary

此命令将 javanile/php-glossary 软件包添加到项目的 composer.json 文件中作为开发依赖项，并将其与其开发依赖项一起安装。

下载文件 bin/glossary 的最新版本，并将其放置在项目的根目录中。

curl -o glossary https://raw.githubusercontent.com/javanile/php-glossary/main/bin/glossary

在项目的根目录中创建一个名为 .glossaryrc 的文件，并添加以下配置

[domain]
terms = Invoice, Customer, Product, Order, Payment, Shipment, Tax, Discount

从命令行运行工具

php vendor/bin/glossary

.glossaryrc 文件应作为应用程序中领域特定术语的中心存储库。我们设想将使用来自各种来源（如业务逻辑分析工具等）的输入来更新此文件的工具。
应教育并鼓励开发者选择在 .glossaryrc 文件中存在的术语。
官方词汇表及其代表文件 .glossaryrc 是项目的重要组成部分，就像测试和固定值一样。
如果开发人员修改 .glossaryrc 文件以通过 CI/CD，他们必须在同行评审阶段进行正当化。这为仅对词汇表文件进行有针对性的检查而不是整个代码库提供了机会。

该项目是一个教育演示，不应在生产环境中使用。它展示了在源代码中识别领域特定术语的想法，并且没有针对现实场景进行优化。将其作为理解软件开发生态中术语分析潜力的起点。

欢迎为增强和扩展 PHP Glossary 功能做出贡献。如果您认为这个概念有价值并希望做出贡献，请遵循存储库中提供的指南。

该项目是开源的，并按照 MIT 许可证发布。请随意使用、修改和分发它，前提是符合许可证条款。