cakephp / cakephp/cakephp-api-docs
cake 5: Support parameters with only type hints
未关闭
还没有人认领这个 Issue。
- 主要语言
- PHP
- 星标
- 29
- 派生
- 15
- PR 合并指标
- 30 天内没有已合并 PR
描述
Starting with cake 5, some function parameters won't have matching docblock @param annotations.
Do we want to still list these parameters in the parameter block with no description or should we hide them?

These parameters won't have a matching annotation because PHP 8 allows union types that fully documents the allowed types and the parameter name is self-documenting (the annotation description isn't helpful).
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先检查带有 PHP 8 类型提示的 CakePHP 5 参数在 API 文档中的表示方式。确定没有匹配的 @param 注解的参数应显示为空描述,还是应被隐藏,然后为所选行为添加覆盖测试。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- php
- 领域
- documentation
- Issue 类型
- 功能
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 35/100