[api-documenter] Annotations on type alias parameters are ignored
維護者通常 1 天內回覆
還沒有人認領這個 Issue。
評估
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 新手友好度
- 45/100
- Issue 類型
- 缺陷
- 描述清晰度
- 基本清楚
- 活躍度
- 停滯
- 技術堆疊
- typescript
研究方向
Start by reproducing the issue in @microsoft/api-documenter with the TypeScript type alias shown in the report and inspect the generated Markdown output. Trace how the alias and its parameter comments are processed. Done means the generated documentation displays the description for bar while preserving the alias description and signature.
由索引模型根據 Issue 內容生成。
描述
Summary
Annotating a type alias as a whole works fine, but individual paramaters are ignored.
Repro steps
Consider the following:
/**
* This is a type alias.
*
* @public
*/
type Foo = {
/**
* This is a parameter.
*/
bar?: unknown;
};
Expected result
For the parameter bar to have its description displayed in the generated markdown file.
Actual result
Generated markdown file:
Foo type
This is a type alias.
Signature:
type Foo = {
bar?: unknown;
};
Standard questions
Please answer these questions to help us investigate your issue more quickly:
| Question | Answer |
|---|---|
@microsoft/api-documenter version? |
7.27.4 |
| Operating system? | Windows |
| Documentation target? | Markdown |
| Would you consider contributing a PR? | Yes |
| TypeScript compiler version? | 5.8.2 |
Node.js version (node -v)? |
24.11.0 |
- 主要語言
- TypeScript
- 星號
- 6.5k
- 分支
- 708
- 平均合併
- 4 天 7 小時
- 30 天內合併 PR
- 61
環境準備
我們還沒有檢查這個專案的環境設定檔。先看它的 README，通用步驟見我們的新手貢獻指南。
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
microsoft/rushstack 的其他 Issue
-
難度 2/5 1-3 小時 新手友好度 72/100
microsoft/rushstack#5971 · 2 則留言 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 65/100
microsoft/rushstack#5902 · 1 個 reaction ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 68/100
microsoft/rushstack#5839 · 1 個 reaction ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 70/100
microsoft/rushstack#5683 · 3 則留言 ·
維護者通常 1 天內回覆
-
難度 4/5 3-5 天 新手友好度 45/100
維護者通常 1 天內回覆
查看 microsoft/rushstack 的全部 Issue
相似的 Issue
-
module-request
難度 2/5 1-3 小時 新手友好度 68/100
維護者通常 1 天內回覆
-
難度 1/5 1 小時以內 新手友好度 90/100
appandflow/stim#1604 · 1 則留言 ·
維護者通常 1 天內回覆
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
難度 1/5 1 小時以內 新手友好度 92/100
lingdojo/kana-dojo#31060 · 1 則留言 · 5 個 reaction ·
維護者通常 1 天內回覆
-
難度 1/5 1 小時以內 新手友好度 90/100
paperclipai/paperclip#14173 ·
維護者通常 1 天內回覆
-
needs-triage
難度 2/5 1-3 小時 新手友好度 85/100
維護者通常 1 天內回覆