reactjs / reactjs/react.dev

Add samples) react components with JSDocs!

未关闭
#1,328 1 条评论 5 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
JavaScript
星标
11.8k
派生
7.9k
平均合并
1 天 11 小时
30 天内合并 PR
11

描述

jsdoc-comment

Please add samples on JSDocs with react, a lot programmers including me need IntelliSense and other benefits like auto-completion and type-checking as well. Migration over to TypeScript is not ideal if you have large code base. Adding a JSDoc comment is the easiest way of getting a lot of TypeScript tooling without configuring any code at all. On top of that vscode already supports it just by turning on in the settings
"javascript.implicitProjectConfig.checkJs": true

It even provides comment template for JavaScript functions when you type/**
jsdoc-autofill

That's way I think reactjs docs should provide examples on this

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

未指定文件或测试;首先查看现有的 React 文档示例,以及请求中的 JSDoc 和 VS Code 上下文。确定哪些示例应演示 JSDoc,然后验证文档包含可用的示例,解释 IntelliSense、补全和类型检查的预期好处。

由索引模型根据 Issue 内容生成。

评估

技术栈
javascript, react
领域
documentation
Issue 类型
文档
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
需要澄清
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。