redhat-developer / redhat-developer/vscode-java

Improve readability of javadoc

未关闭
#3,773 8 条评论 3 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

enhancement javadoc
主要语言
TypeScript
星标
2.3k
派生
546
平均合并
20 小时 1 分钟
30 天内合并 PR
11

描述

It would be great if we can read the javado in visual studio editor in an human readable format, instead the code format.

Current Result

Reading documentation in this format is hard.
image

Expected Result

Having a away to read it in an human readable format, in all objects (files in vscode or referenced through maven or gradel)

Additional Informations

If this already exists, sorry and please let me know.

贡献指南

打开贡献指南

从这里开始

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

调研方向

首先,在 Visual Studio Code 编辑器中复现来自本地文件以及通过 Maven 或 Gradle 引用的依赖项中的 Java 对象的 JavaDoc 显示效果。将当前的代码格式化结果与所要求的人类可读格式进行比较,并在确定扩展的入口点和合适的测试之前,定义所有被引用对象的覆盖范围。

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

评估

技术栈
java, typescript, vscode
领域
developer-experience, documentation
Issue 类型
功能
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
需要澄清
新手友好度
30/100

把新 issue 发到你的邮箱

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