如何使用 Mermaid、GitHub 和 VSCode 用代码创建关系图二

这篇具有很好参考价值的文章主要介绍了如何使用 Mermaid、GitHub 和 VSCode 用代码创建关系图二。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

Mermaid 系列

  • 如何使用 Mermaid、GitHub 和 VSCode 用代码创建关系图一
    mermaid git,LLM-Large Language Models,github,vscode,ide,Mermaid

1. 如何使用 Mermaid 生成图表

Mermaid 是一个基于 JavaScript 的工具,可将 Markdown 样式的文本转换为动态图表,让您可以毫不费力地创建和修改它们。

Mermaid 使使用简单的文本和代码轻松生成图表和视觉效果变得容易。

它遵循一个简单的语法:

mermaid git,LLM-Large Language Models,github,vscode,ide,Mermaid
使用 Mermaid,您可以生成以下图表类型:

  • Flowchart 流程图
  • Sequence Diagram 序列图
  • Class Diagram 类图
  • Gantt 甘特
  • Pie Chart 饼图

让我们一一探讨它们。

2. 如何创建流程图 flowchart

流程图是一张使用符号显示过程步骤的图片,有助于以清晰有条理的方式解释过程。流程图由通过箭头连接的节点组成。

您可以使用以下示例在 mermaid 中渲染流程图:
mermaid git,LLM-Large Language Models,github,vscode,ide,Mermaid

语法细分:

  • flowchart:此关键字表示我们正在创建流程图。
  • TD: 这是流程图的方向,代表自上而下。其他流程图方向包括:
  • TB - 从上到下,与TD相同。
  • BT - 从下到上
  • LR - 从左到右
  • RL - 从右到左
  • -->:连接节点的箭头方向。

3. 如何创建序列图 sequenceDiagram

序列图是流程之间交互的说明性表示,展示了它们的操作流程和执行顺序。

您可以使用以下语法在 mermaid 中渲染序列图:
mermaid git,LLM-Large Language Models,github,vscode,ide,Mermaid

语法细分:

  • sequenceDiagram:此关键字指定我们正在制作序列图。
  • participant:这些是序列图中的参与者或actor。
  • activate/ deactivate:可以激活和停用 actor。激活在交互之间显示为一个小矩形。
  • -->>:连接线(虚线)。
  • ->:连接线(实心)。

4. 如何创建类图 classDiagram

类图用于可视化类、接口的结构和关系,以及它们在面向对象编程 (OOP) 中的交互。您可以使用以下语法在 Mermaid 中渲染类图:
mermaid git,LLM-Large Language Models,github,vscode,ide,Mermaid

语法细分:

  • 定义类class:使用 class 关键字后跟类名定义单个类。
  • 添加类属性:类属性添加时带有 + 号。在上面的示例中,+breed 是一个属性。
  • 添加方法:mermaid使用圆括号()识别方法。请注意,所有属性和方法都使用大括号{}分组到同一类下。
  • 定义返回类型:返回类型在方法名称/类名之后定义。stringvoid 是上述代码中的返回类型。
  • 定义关系:在 OOP 中,关系是在类图和对象图上找到的特定类型的逻辑连接。mermaid支持以下关系类型:
TYPE类型 DESCRIPTION描述
<!-- 注意把!换成中划线 Inheritance 继承
*-- Composition 组合
o---- Aggregation 聚合
--> Association 协作
-- Link (Solid)链接(实心)
..> Dependency 依赖
..!> 注意把!换成中划线 Realization实现
.. Link (Dashed)链接(虚线)

下面是继承的快速实现:
mermaid git,LLM-Large Language Models,github,vscode,ide,Mermaid

代码

https://github.com/zgpeace/pets-name-langchain/tree/develop

参考

https://www.freecodecamp.org/news/diagrams-as-code-with-mermaid-github-and-vs-code/文章来源地址https://www.toymoban.com/news/detail-841385.html

到了这里,关于如何使用 Mermaid、GitHub 和 VSCode 用代码创建关系图二的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 使用VSCode创建自定义注释及代码段的方法

    1.打开VSCode活动栏中的管理面版 2.点击配置用户用户代码片段。如下图所示 3.点击新建全局代码片段文件 4.输入代码段文件名,如需注释c语言的代码,则文件命名为c.json 5.以c语言为例,建立的文件默认模板如下: 其中\\\"Print to console\\\"为添加代码段的说明。 \\\"prefix\\\"为调用这个代

    2024年03月20日
    浏览(40)
  • 如何使用VSCode创建编辑Markdown文件

            前往VSCode的官方网站下载并安装VSCode。VSCode的安装步骤很简单,可以在网上搜索一篇教程并按照教程一步步安装即可。VSCode的官方网站下载位置如下图: 打开VSCode软件 点击软件左侧的扩展按钮,如下图: 然后在搜索框搜索需要安装的插件,点击\\\"Install\\\"按钮,等待

    2024年02月08日
    浏览(35)
  • 如何在VScode和Jetbrain上使用备受争议的GitHub Copilot

    https://docs.github.com/en/copilot/quickstart 配置好之后,就是这种效果,真实太NB了!!! 一个 tab 就把所有的代码都填充上去了! https://docs.github.com/en/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-a-jetbrains-ide 一直卡在这个步骤,不知道怎么回事: Retrieving github d

    2023年04月17日
    浏览(56)
  • 如何使用curl下载github代码

    首先通过chrome打开想要下载的源文件 如图,有那个下载图标时表示不需要鉴权即可下载,一般仓库都会开放只读权限,所以很大概率都有 比如我想下载这个crc32.c文件 那么我就需要知道它在哪个IP中,按下F12打开网络,点击下载图标 上图为文件所在位置 使用如下命令进行下

    2024年02月16日
    浏览(37)
  • VScode配置 github 上传代码

    其中,第3步可以使用ssh登录,ssh设置可以参考 github 关于 ssh 的文档操作 主要命令如下: 生成公钥的存储路径为 C:UsersLenovo.ssh , .pub 文件保存公钥,如下图: 在 github 账号的 Setting 里面添加 SSH key (将上图中的公钥复制到github中),如下图所示:

    2024年02月05日
    浏览(36)
  • 一文学会VSCode代码同步至GitHub

    上手GItHub之前首先要了解一下GItHub的,如下: 此处忽略 按以下步骤创建 点击新建仓库按钮跳转新建仓库页面,如下图 点击 Create repository 按钮创建仓库会调整至以下页面 这里我们点击在仓库中新建一个文件以演示github的使用。 这里我们在详细备注中输入 版本1 后点击

    2024年02月13日
    浏览(44)
  • 如何使用 Python 通过代码创建图表

    简介 Diagram as Code 工具允许您创建基础架构的架构图。您可以重复使用代码、测试、集成和自动化绘制图表的过程,这将使您能够将文档视为代码,并构建用于映射基础架构的流水线。您可以使用 diagrams 脚本与许多云提供商和自定义基础架构。 在本教程中,您将使用 Python 创

    2024年02月20日
    浏览(45)
  • 如何使用iPad Pro结合内网穿透在公网使用VScode远程代码开发

    本文主要介绍开源iPad应用IDE Code App 如何下载安装,并通过cpolar内网穿透工具实现SSH远程连接服务器进行云端编程开发,有效节省工作时间并提高开发效率。 随着平板电脑的普及,它已经不仅仅是一个娱乐工具,而是逐渐融入我们的工作与生产活动中。更为值得一提的是,强

    2024年03月27日
    浏览(56)
  • 如何在GitHub上面上传自己的项目/使用Github上传本地项目代码/怎样在GitHub上传自己的项目/github怎么上传一整个工程

    目录 1 注册github账号 2 第一次上传自己的项目 2.1下载git 2.2、新建仓库 2.3、上传项目 3、更新自己的项目 4、建立分支,修改分支 5、bug1 6、bug2 这个不教好吧 2.1 下载git 官网链接,安装不要选择带中文和空格的路径,直接next就行 2.2 新建仓库 右上角+,选择New repository,给项目

    2024年02月06日
    浏览(65)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包