Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[other:*] vscode自动关联idux文档;做到代码即文档 #1026

Closed
1 task done
huangtenghui opened this issue Jul 19, 2022 · 4 comments · Fixed by #1063, #1062, #1066, #1067 or #1069
Closed
1 task done

[other:*] vscode自动关联idux文档;做到代码即文档 #1026

huangtenghui opened this issue Jul 19, 2022 · 4 comments · Fixed by #1063, #1062, #1066, #1067 or #1069
Assignees
Labels
Docs Improvements or additions to documentation Other:*

Comments

@huangtenghui
Copy link

  • I have searched the issues of this repository and believe that this is not a duplicate.

What problem does this feature solve?

降低上手成本及提效;vscode一键解决;

What does the proposed API look like?

vscode、webstorm插件

@idux-bot idux-bot bot added the Other:* label Jul 19, 2022
@idux-bot
Copy link

idux-bot bot commented Jul 19, 2022

Translation of this issue:

[Other:*] VSCode automatic associated IDUX document;

What PROBLEM DOES This Feature Solve?

Reduce the cost of getting started; VSCODE solves one click;

What does the proposed api look like?

vscode, webstorm plugin

@danranVm
Copy link
Member

image

可以写个脚本,把现有的 API 都抓取,生成 json

@danranVm danranVm added the Docs Improvements or additions to documentation label Jul 19, 2022
@tuchg
Copy link
Contributor

tuchg commented Jul 20, 2022

image
image

IDE其实都有支持,这也是种方案,可以延伸到通过tsdoc读取注释生成idux-site,进一步提效,降低手工文档的工作量提高组件开发、使用效率
真正做到代码即文档,在静态语言里这是很成熟常见的方案

@tuchg tuchg self-assigned this Jul 20, 2022
@tuchg
Copy link
Contributor

tuchg commented Aug 6, 2022

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment