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

在 .vue 和 .ts 的 export default 上面添加文档注释 #817

Closed
LinWanCen opened this issue Feb 6, 2025 · 5 comments
Closed

在 .vue 和 .ts 的 export default 上面添加文档注释 #817

LinWanCen opened this issue Feb 6, 2025 · 5 comments
Assignees
Labels
wontfix This will not be worked on

Comments

@LinWanCen
Copy link

<script lang="ts">
/**
 * 基础列表页
 */
export default {
  name: 'ListBase',
};
</script>

<script lang="ts">
export default {
name: 'ListBase',
};
</script>

我的注释插件将会读取这个注释作为左侧文件树的注释,方便查看代码。
旧版可以加载路由配置的注释,新版的路由是调用 API 的难以获取。

https://plugins.jetbrains.com/plugin/18553-show-comment

Copy link
Contributor

github-actions bot commented Feb 6, 2025

👋 @LinWanCen,感谢给 TDesign 提出了 issue。
请根据 issue 模版确保背景信息的完善,我们将调查并尽快回复你。

Copy link
Contributor

github-actions bot commented Feb 6, 2025

♥️ 有劳 @timi137137 @liweijie0812 尽快确认问题。
确认有效后将下一步计划和可能需要的时间回复给 @LinWanCen

@LinWanCen
Copy link
Author

@timi137137
Copy link
Collaborator

首先感谢您提出该issue,对于TD来说,为了项目总体代码简洁性相关考虑,在通常情况下我们暂时不会为了特地区分目录结构而去为每一个文件新增注释。

您可以在fork后对自己的代码做出变更

@timi137137 timi137137 added the wontfix This will not be worked on label Feb 15, 2025
@LinWanCen
Copy link
Author

其实我的目的是希望 TD 作为国内顶级 UI 之一,通过示例普及在 export default 上写注释的写法,有利于复杂业务的快速理解上手。
看看 JetBrains 官方会不会做这个功能先,我看到你们的标签注释这块就比饿了么只有英文的好很多。
Image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
wontfix This will not be worked on
Projects
None yet
Development

No branches or pull requests

3 participants