Skip to content

Add possibility to visualize diagram from comment block in code #141

@miman

Description

@miman

The PlantUML plugin has a very nice feature that would be great if it also worked with Mermaid.

You can add a plantUML block in a comment in the code file and open the visualizer which then displays a diagram of the comment block where the cursor is located (so if there are several blocks in a file you can just go to the next block to visualize that block).

This way you can have a sequence diagram of a handler block directly in the code, minimizing the work for the developer to find the documentation file for that handler.

If you add a name to the plantuml block, that name will be used when generating an SVG, PNG... file export of that diagram (-> my-name.svg in the example below).

Example:
/**
*@startuml my-name
*[PlantUML block]
*@enduml
*/

It would be great if this functionality also would be available for Mermaid

Thanks for a great tool :-)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions