通过
进行搜索
进行搜索atkinshealth / silverstripe-autodoc
根据字段和关系自动生成DataObject子类的PHPDoc注释。
1.1.1
2024-09-29 23:19 UTC
Requires
- php: ^7 | ^8
- atanamo/php-codeshift: ^1
- silverstripe/framework: ^4.0 || ^5
Requires (Dev)
- phpunit/phpunit: ^5.7
- squizlabs/php_codesniffer: ^3.0
This package is auto-updated.
Last update: 2024-09-29 23:23:14 UTC
README
根据字段和关系自动生成DataObject子类的PHPDoc注释。注释的开头保留现有的PHPDoc注释和指令。
要求
- SilverStripe ^4.0
安装
composer require --dev atkinshealth/silverstripe-autodoc 1.x-dev
许可
请参阅许可
文档
由于此模块直接修改您的源 .php 文件，建议您仅在具有干净工作副本的源代码控制项目上运行它。要运行文档块生成，请通过sake访问/dev/autodoc
./vendor/bin/sake dev/autodoc module=app flush=1
如果省略了模块参数，则默认为app模块。这可以通过yaml配置进行更改
示例配置
默认情况下，此模块为app模块生成docblocks，这是新SilverStripe项目的默认模块。此默认值可以更改。
AtkinsHealth\AutoDoc\AutoDocController: default_module: mysite
维护者
- Mason Dechaineux mason@atkinshealth.com.au
问题追踪器
在此存储库的问题部分跟踪问题。在提交问题之前，请仔细阅读现有问题，以确保您的问题独特。
如果问题看起来像是一个新问题
- 创建一个新问题
- 描述重现您问题的步骤和预期结果。单元测试或命令输出可能在这里有所帮助。
- 尽可能详细地描述您的环境：SilverStripe版本、PHP版本、操作系统、安装的任何SilverStripe模块。
请直接向模块维护者报告安全问题。请不要在问题跟踪器中提交安全问题。
开发和贡献
如果您想为此模块做出贡献，请确保提出一个pull request并与模块维护者进行讨论。