Issue in generating html output with '&' in @param
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 42/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- javascript
调研方向
使用提供的 @param docstring 重现报告的案例，并使用 Node v20.15.0 运行 npm run documentation。将生成的 HTML 与预期的 body(Required<Pick<Model1, 'name'>> & Partial<Model1>) specification 输出进行比较，并查看相关 issue #1641 了解上下文；完成的标准是类型得到保留，而不是变成 any。
由索引模型根据 Issue 内容生成。
描述
For below docstring:
@param { Required<Pick<Model1, 'name'>> & Partial<Model1> } body specification
expectation is to see below format in documentation:
body(Required<Pick<Model1, 'name'>> & Partial<Model1>) specification
but I can see:
body(any) specification
version of documentation pkg: 14.0.3
running documentation: npm run documentation
node version: v20.15.0
Similar issue which was created earlier: https://github.com/documentationjs/documentation/issues/1641
- 主要语言
- JavaScript
- 星标
- 5.8k
- 派生
- 479
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
documentationjs/documentation 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 82/100
documentationjs/documentation#1669 · 1 条评论 ·
-
难度 4/5 3-5 天 新手友好度 35/100
documentationjs/documentation#1666 · 2 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 35/100
documentationjs/documentation#1646 ·
-
难度 3/5 1-2 天 新手友好度 45/100
documentationjs/documentation#1644 ·
-
难度 3/5 1-2 天 新手友好度 35/100
documentationjs/documentation#1643 · 1 条评论 ·
查看 documentationjs/documentation 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 77/100
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 80/100
MagicMirrorOrg/MagicMirror#4310 · 1 条评论 · 1 个 reaction ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
bluerobotics/Cockpit-docs#48 ·
-
难度 2/5 1-3 小时 新手友好度 78/100
tc39/proposal-temporal#3332 ·
-
难度 2/5 1-3 小时 新手友好度 78/100
opennextjs/opennextjs-cloudflare#1461 ·
维护者通常 1 天内回复