C4-Model Context

本文章描述基于 C4-Model + PlantUML + VSCode 开发设计软件架构,相关环境搭建参看:C4-Model 开发环境搭建

1. Person

请添加图片描述

函数名Person ($alias, $label, $descr="", $sprite="", $tags="", $link="")
参数
alias(必须)定义Person的一个别名,用于后续设计的调用
label(必须)用于定义在图形上显示的标签, 可以使用字符串,也可以直接输入
descr增加对Person的详细描述
sprite修改图标,C4提供两种图标,分别为person / person2
tags增加一个自定义的 tag, 默认tag为 person
link 增加一个链接,实现点击跳转的功能

2. Person_Ext

请添加图片描述

函数名Person_Ext ($alias, $label, $descr="", $sprite="", $tags="", $link="")
参数参见:Person

3. System

在这里插入图片描述

函数名System ($alias, $label, $descr="", $sprite="", $tags="", $link="")
参数参见:Person

4. System_Ext

在这里插入图片描述

函数名System_Ext ($alias, $label, $descr="", $sprite="", $tags="", $link="")
参数参见:Person

5. SystemDb

在这里插入图片描述

函数名SystemDb ($alias, $label, $descr="", $sprite="", $tags="", $link="")
参数参见:Person

6. SystemQueue

在这里插入图片描述

函数名SystemQueue ($alias, $label, $descr="", $sprite="", $tags="", $link="")
参数参见:Person

7. SystemDb_Ext

在这里插入图片描述

函数名SystemDb_Ext ($alias, $label, $descr="", $sprite="", $tags="", $link="")
参数参见:Person

8. SystemQueue_Ext

在这里插入图片描述

函数名SystemQueue_Ext ($alias, $label, $descr="", $sprite="", $tags="", $link="")
参数参见:Person

9. Enterprise_Boundary

在这里插入图片描述

函数名Enterprise_Boundary ($alias, $label, $tags="", $link="")
参数参见:Person

10. System_Boundary

在这里插入图片描述

函数名System_Boundary($alias, $label, $tags="", $link="")
参数参见:Person

11. AddPersonTag

在这里插入图片描述

函数名AddContainerTag ( $tagStereo, $bgColor=$CONTAINER_BG_COLOR, $fontColor=$ELEMENT_FONT_COLOR, $borderColor=$CONTAINER_BORDER_COLOR, $shadowing="", $shape="", $sprite="", $legendText="", $legendSprite="")
参数
tagStereo(必须)设置一个标签的名称,用于后续的调用与显示,设置值为显示值
bgColor设置容器的背景颜色
fontColor设置容器的字体颜色
borderColor设置边框的颜色
shadowing是否显示阴影,true 或者 false
shape 为容器设置一个图标,
默认为直角
roundedBox 圆角
eightSided 斜角
sprite 设置一个图标
techn为容器增加一个技术栈,如果在容器定义中重新声明则显示容器中的定义
legendText设置在图例中显示的标题
legendSprite设置一个在图例中显示的图标,默认为上面参数sprite设置的图标

11. AddExternalPersonTag

在这里插入图片描述

函数名AddExternalPersonTag ( $tagStereo, $bgColor=$CONTAINER_BG_COLOR, $fontColor=$ELEMENT_FONT_COLOR, $borderColor=$CONTAINER_BORDER_COLOR, $shadowing="", $shape="", $sprite="", $legendText="", $legendSprite="")
参数参见:AddPersonTag

12. AddSystemTag

在这里插入图片描述

函数名AddSystemTag ( $tagStereo, $bgColor=$CONTAINER_BG_COLOR, $fontColor=$ELEMENT_FONT_COLOR, $borderColor=$CONTAINER_BORDER_COLOR, $shadowing="", $shape="", $sprite="", $legendText="", $legendSprite="")
参数参见:AddPersonTag

13. AddExternalSystemTag

在这里插入图片描述

函数名AddExternalSystemTag ( $tagStereo, $bgColor=$CONTAINER_BG_COLOR, $fontColor=$ELEMENT_FONT_COLOR, $borderColor=$CONTAINER_BORDER_COLOR, $shadowing="", $shape="", $sprite="", $legendText="", $legendSprite="")
参数参见:AddPersonTag

14. 代码实例

@startuml
!define RELATIVE_INCLUDE /Users/xxx/C4-PlantUML
!include RELATIVE_INCLUDE/C4_Context.puml
!include <office/Users/um_enabled_user>

Person(person, "成员 A", "一个C4 demo 程序的一个成员") 
Person_Ext(person_ext, "外部成员 B", "一个C4 demo 程序的一个外部成员") 
System(sys, "系统 A", "一个 C4 Model 系统")
System_Ext(sys_ext, "系统 A", "一个 C4 Model 系统")
SystemDb(sysdb, "系统 A", "一个 C4 Model 系统")
SystemQueue(sysq, "系统 A", "一个 C4 Model 系统")
SystemDb_Ext(sysdb_ex, "系统 A", "一个 C4 Model 系统")
SystemQueue_Ext(sysq_ex, "系统 A", "一个 C4 Model 系统")
Enterprise_Boundary(ent_b, "系统 A", "一个 C4 Model 系统")
System_Boundary(sys_b, "系统 A", "一个 C4 Model 系统")

AddExternalSystemTag("AddTag", $fontColor=$ELEMENT_FONT_COLOR, $borderColor=$PERSON_BORDER_COLOR, $shadowing="", $shape="", $sprite=um_enabled_user, $legendText="", $legendSprite="")
System(a, "成员 A", "一个C4 demo 程序的一个成员", $tags = "AddTag" , "") 

' 显示图例,隐藏标签
SHOW_LEGEND()
@enduml

在这里插入图片描述

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值