zooo
V2EX  ›  问与答

在代码注释中插入图片?

  •  
  •   zooo · Apr 14, 2022 · 4846 views
    This topic created in 1668 days ago, the information mentioned may be changed or developed.

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

    Supplement 1  ·  Apr 14, 2022
    补充:
    比如 java 、python 常用的工具 idea pycharm 等,比如 vscode

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

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

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

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

    我选择用 draw.io 做好图上传到图床,注释里贴图片直链
    cnit
    cnit
    Apr 15, 2022
    15
    注释可以写 html 代码 整个 a 、img 标签
    cxtrinityy
    cxtrinityy
    Apr 16, 2022 via Android
    16
    Rxjava 就有图片注释可以看看
    WebKit
    WebKit
    Apr 19, 2022 via Android
    17
    java 的注释是可以写 html 标签的。
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Privacy   ·   Solana   ·   721 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 46ms · UTC 22:10 · PVG 06:10 · LAX 14:10 · JFK 17:10
    ♥ Do have faith in what you're doing.