V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX 提问指南
zooo
V2EX  ›  问与答

在代码注释中插入图片?

  •  
  •   zooo · 2022-04-14 14:37:38 +08:00 · 3505 次点击
    这是一个创建于 938 天前的主题,其中的信息可能已经有所发展或是发生改变。

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

    第 1 条附言  ·  2022-04-14 16:01:38 +08:00
    补充:
    比如 java 、python 常用的工具 idea pycharm 等,比如 vscode

    对于某一段代码,直接在注释 /* 图片 */ // 图片

    代码上面可以显示图片,不用在游览器中另外打开,支持折叠图片。

    另外,不是那种用纯文本画得流程图,因为可以图片表示的内容很复杂。
    17 条回复    2022-04-19 20:35:10 +08:00
    longbow0
        1
    longbow0  
       2022-04-14 14:48:12 +08:00
    是类似于 Rmarkdown 这样的吗?
    micean
        2
    micean  
       2022-04-14 15:07:02 +08:00
    如果确实有需要图片或者文件的地方,直接把图片 /文件放到项目里即可
    zhazi
        3
    zhazi  
       2022-04-14 15:09:25 +08:00
    去看下 reactor 的 api
    wellsc
        4
    wellsc  
       2022-04-14 15:13:06 +08:00
    单独写一份文档不行吗’
    seakingii
        5
    seakingii  
       2022-04-14 15:20:04 +08:00
    ┌───────────────┐ ┌────────────────┐ ┌────────────────────┐
    │ │ │ │ │ │
    │ 1 ├──────────► 2 ├────────►│ 3 │
    │ │ │ │ │ │
    └───────────────┘ └────────────────┘ └─────────┬┬─────────┘
    └┤





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

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


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


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

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

    我选择用 draw.io 做好图上传到图床,注释里贴图片直链
    cnit
        15
    cnit  
       2022-04-15 16:14:34 +08:00
    注释可以写 html 代码 整个 a 、img 标签
    cxtrinityy
        16
    cxtrinityy  
       2022-04-16 12:36:26 +08:00 via Android
    Rxjava 就有图片注释可以看看
    WebKit
        17
    WebKit  
       2022-04-19 20:35:10 +08:00 via Android
    java 的注释是可以写 html 标签的。
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   3462 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 38ms · UTC 00:43 · PVG 08:43 · LAX 16:43 · JFK 19:43
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.