在代码注释中插入图片?

2022-04-14 14:37:38 +08:00
 zooo

比如对于难以理解的代码或者函数片段使用图像画出流程图,方便理解 有没有这样的功能 /需求

3290 次点击
所在节点    问与答
17 条回复
longbow0
2022-04-14 14:48:12 +08:00
是类似于 Rmarkdown 这样的吗?
micean
2022-04-14 15:07:02 +08:00
如果确实有需要图片或者文件的地方,直接把图片 /文件放到项目里即可
zhazi
2022-04-14 15:09:25 +08:00
去看下 reactor 的 api
wellsc
2022-04-14 15:13:06 +08:00
单独写一份文档不行吗’
seakingii
2022-04-14 15:20:04 +08:00
┌───────────────┐ ┌────────────────┐ ┌────────────────────┐
│ │ │ │ │ │
│ 1 ├──────────► 2 ├────────►│ 3 │
│ │ │ │ │ │
└───────────────┘ └────────────────┘ └─────────┬┬─────────┘
└┤





┌──────────▼──────────┐
│ │
│ 4 │
┌───────────────────────────────────┤ │
│ └─────────────────────┘

┌─────────────────────────────────┐
│ │
│ │
│ 5 │
│ │
└─────────────────────────────────┘
seakingii
2022-04-14 15:22:01 +08:00
┌────────┐ ┌─────────┐
│ 1 ├───┤ 2 │
└────────┘ ▼└─────────┴┐


┌─▼──────┐
│ 3 │
└────┬───┘


│ ┌────────────┐
└────►│ 4 │
└────────────┘
seakingii
2022-04-14 15:22:50 +08:00
汗,在 V2EX 这里回复,太难看了

你这种需求叫 ASCII FLOW,很多工具
seakingii
2022-04-14 15:26:29 +08:00
zhazi
2022-04-14 15:32:23 +08:00
![java-doc]( https://imgur.com/a/a1KbR4D) java-doc 本身就支持图片
zooo
2022-04-14 16:02:51 +08:00
@zhazi 有点像
不过我想的是那种在代码编辑器中直接显示图像
ThirdFlame
2022-04-14 16:58:15 +08:00
可以插入一段 图片的 base64 . 就看 ide 有没有渲染能力了
fgwmlhdkkkw
2022-04-14 17:05:19 +08:00
@ThirdFlame #11 那注释比代码还多,怎么维护啊
weixiangzhe
2022-04-14 17:13:20 +08:00
这个就可以了吧 https://asciiflow.com/#/
AllenHua
2022-04-15 00:08:05 +08:00
如果是复杂的函数流程图还有各种配色区分(举个例子)

我选择用 draw.io 做好图上传到图床,注释里贴图片直链
cnit
2022-04-15 16:14:34 +08:00
注释可以写 html 代码 整个 a 、img 标签
cxtrinityy
2022-04-16 12:36:26 +08:00
Rxjava 就有图片注释可以看看
WebKit
2022-04-19 20:35:10 +08:00
java 的注释是可以写 html 标签的。

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/846932

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX