{"id":2130,"date":"2026-05-26T06:46:41","date_gmt":"2026-05-26T06:46:41","guid":{"rendered":"https:\/\/www.vpascode.com\/pt\/docs\/uncategorized\/plantuml-syntax-basics\/"},"modified":"2026-05-26T06:46:41","modified_gmt":"2026-05-26T06:46:41","slug":"plantuml-syntax-basics","status":"publish","type":"ld_docs","link":"https:\/\/www.vpascode.com\/pt\/docs\/vpascode-docs\/plantuml-syntax-basics\/","title":{"rendered":"No\u00e7\u00f5es B\u00e1sicas da Sintaxe do PlantUML"},"content":{"rendered":"<p>Antes de mergulhar em layouts arquitet\u00f4nicos espec\u00edficos, como modelos C4 ou cronogramas de sequ\u00eancia, \u00e9 essencial compreender as regras fundamentais que regem o <strong>Guia Pr\u00e1tico do PlantUML<\/strong>. O PlantUML depende de um sistema de nota\u00e7\u00e3o de texto limpo e altamente intuitivo. Uma vez que voc\u00ea entenda como o motor abre documentos, nomeia componentes estruturais e roteia linhas de conex\u00e3o, escrever qualquer layout de sistema complexo torna-se completamente natural.<\/p>\n<p>Este breve guia aborda as mec\u00e2nicas sint\u00e1ticas estruturais globais que se aplicam a quase todos os tipos de diagramas PlantUML dentro do ambiente VPasCode.<\/p>\n<h2>1. Os Envolt\u00f3rios Obrigat\u00f3rios do Documento<\/h2>\n<p>Cada bloco individual de c\u00f3digo PlantUML deve come\u00e7ar e terminar com tags expl\u00edcitas de estrutura. Essas tags informam ao analisador VPasCode para iniciar o motor de renderiza\u00e7\u00e3o correto na sua \u00e1rea de visualiza\u00e7\u00e3o:<\/p>\n<ul>\n<li><code>@startuml<\/code> \u2014 Esta linha exata deve ser colocada na parte superior absoluta do seu script. Nada mais deve preced\u00ea-la.<\/li>\n<li><code>@enduml<\/code> \u2014 Esta linha exata deve ser colocada na parte inferior absoluta do seu script, marcando o fim do bloco de dados do seu diagrama.<\/li>\n<\/ul>\n<p>Qualquer c\u00f3digo escrito fora desses dois marcadores ser\u00e1 ignorado com seguran\u00e7a pelo compilador, ou pode acionar um aviso de valida\u00e7\u00e3o de sintaxe no painel de diagn\u00f3stico do seu workspace.<\/p>\n<h2>2. Declarando Elementos: IDs vs. R\u00f3tulos de Exibi\u00e7\u00e3o<\/h2>\n<p>Ao modelar um sistema de software, voc\u00ea criar\u00e1 diversos elementos estruturais, como componentes, bancos de dados, atores ou microsservi\u00e7os. No PlantUML, voc\u00ea pode declarar um elemento explicitamente definindo seu tipo, uma ID curta interna e um nome de exibi\u00e7\u00e3o amig\u00e1vel, cercado por aspas:<\/p>\n<pre><code>componente microservice_id como \"API de Processamento de Pagamentos\"\r\ndatabase db_id como \"SQL de Transa\u00e7\u00f5es do Usu\u00e1rio\"<\/code><\/pre>\n<p><strong>Por que esta \u00e9 uma melhor pr\u00e1tica:<\/strong> Usar uma ID interna curta e limpa (como <code>microservice_id<\/code>) torna muito mais r\u00e1pido desenhar linhas de relacionamento posteriormente. Se voc\u00ea precisar alguma vez mudar o r\u00f3tulo vis\u00edvel para o cliente de \u201cAPI de Processamento de Pagamentos\u201d para \u201cServi\u00e7o de Checkout Global\u201d, voc\u00ea precisar\u00e1 editar apenas uma \u00fanica linha de c\u00f3digo, em vez de atualizar dezenas de linhas em todo o seu script.<\/p>\n<h2>3. Dominando Setas de Relacionamento e Roteamento Direcional<\/h2>\n<p>As conex\u00f5es entre n\u00f3s do sistema s\u00e3o desenhadas usando combina\u00e7\u00f5es de tra\u00e7os (<code>-<\/code>) e colchetes de seta (<code>&gt;<\/code>). O comprimento dos seus tra\u00e7os e a inclus\u00e3o de palavras-chave direcionais lhe d\u00e3o controle impl\u00edcito sobre como o motor de layout autom\u00e1tico escala o seu diagrama:<\/p>\n<ul>\n<li><strong>Conex\u00f5es B\u00e1sicas:<\/strong> <code>A --&gt; B<\/code> desenha uma seta direcional padr\u00e3o apontando do elemento A diretamente para o elemento B.<\/li>\n<li><strong>Linhas de Depend\u00eancia Pontilhadas:<\/strong> Substituir tra\u00e7os por pontos cria uma linha pontilhada, que \u00e9 o padr\u00e3o da ind\u00fastria para indicar depend\u00eancias ass\u00edncronas ou chamadas de rede: <code>A ..&gt; B<\/code>.<\/li>\n<li><strong>For\u00e7ando a Orienta\u00e7\u00e3o do Layout:<\/strong> Embora o motor de layout espa\u00e7e as caixas automaticamente, voc\u00ea pode orientar explicitamente a dire\u00e7\u00e3o inserindo uma palavra-chave de dire\u00e7\u00e3o diretamente na string da seta:\n<ul>\n<li><code>A -up-&gt; B<\/code> (For\u00e7a B a ser renderizado acima de A)<\/li>\n<li><code>A -down-&gt; B<\/code> (For\u00e7a B a ser renderizado abaixo de A)<\/li>\n<li><code>A -left-&gt; B<\/code> (For\u00e7a B a ser renderizado \u00e0 esquerda de A)<\/li>\n<li><code>A -right-&gt; B<\/code> (For\u00e7a B a ser renderizado \u00e0 direita de A)<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2>4. Adicionando Contexto Inline: R\u00f3tulos e Coment\u00e1rios de C\u00f3digo<\/h2>\n<p>Documenta\u00e7\u00e3o clara depende muito de colocar o contexto apropriado ao redor das suas linhas visuais e scripts de texto:<\/p>\n<h3>Rotulando Linhas de Conex\u00e3o<\/h3>\n<p>Voc\u00ea pode adicionar texto explicativo diretamente em qualquer linha de conex\u00e3o acrescentando dois pontos (&#8220;<code>:<\/code>) logo ap\u00f3s o seu mapeamento de relacionamento:<\/p>\n<pre><code>client_id --&gt; api_id : \"POST HTTPS \/v1\/checkout\"<\/code><\/pre>\n<h3>Escrevendo Coment\u00e1rios de C\u00f3digo<\/h3>\n<p>Se voc\u00ea quiser deixar uma nota administrativa, cr\u00e9dito de design ou explica\u00e7\u00e3o arquitet\u00f4nica dentro do seu arquivo de script sem renderizar uma caixa visual na tela, use um caractere de ap\u00f3strofo (&#8220;<code>'<\/code>). Isso informa ao motor para ignorar completamente a an\u00e1lise dessa linha:<\/p>\n<pre><code>' TODO: Precisamos atualizar esta caixa de limite assim que a migra\u00e7\u00e3o DevOps for conclu\u00edda\r\n[Mon\u00f3lito Legado] --&gt; [Novo Microservi\u00e7o]<\/code><\/pre>\n<p>Agora que voc\u00ea est\u00e1 familiarizado com os envolt\u00f3rios de sintaxe global, declara\u00e7\u00f5es de componentes e par\u00e2metros de setas direcionais do PlantUML, voc\u00ea est\u00e1 perfeitamente preparado para come\u00e7ar a criar formas avan\u00e7adas de sistema. Prossiga para a pr\u00f3xima p\u00e1gina para desbloquear nossa cole\u00e7\u00e3o de <strong>Diagramas de Arquitetura e de Projeto de Alto N\u00edvel<\/strong>!<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Antes de mergulhar em layouts arquitet\u00f4nicos espec\u00edficos, como modelos C4 ou cronogramas de sequ\u00eancia, \u00e9 essencial compreender as regras fundamentais que regem o Guia Pr\u00e1tico do PlantUML. O PlantUML depende de um sistema de nota\u00e7\u00e3o de texto limpo e altamente&#8230;<\/p>\n","protected":false},"author":4,"featured_media":0,"parent":0,"menu_order":0,"template":"","meta":{"inline_featured_image":false,"site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"default","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","ast-disable-related-posts":"","theme-transparent-header-meta":"default","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"set","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}}},"ld_collection":[14],"class_list":["post-2130","ld_docs","type-ld_docs","status-publish","hentry","ld_collection-vpascode-docs"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v27.6 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>PlantUML Syntax Basics | VPasCode Text to Diagram Guide<\/title>\n<meta name=\"description\" content=\"Master PlantUML syntax fundamentals in VPasCode, a versatile diagram-as-code tool to convert text to diagram architecture maps.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.vpascode.com\/pt\/docs\/vpascode-docs\/plantuml-syntax-basics\/\" \/>\n<meta property=\"og:locale\" content=\"pt_PT\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"PlantUML Syntax Basics | VPasCode Text to Diagram Guide\" \/>\n<meta property=\"og:description\" content=\"Master PlantUML syntax fundamentals in VPasCode, a versatile diagram-as-code tool to convert text to diagram architecture maps.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.vpascode.com\/pt\/docs\/vpascode-docs\/plantuml-syntax-basics\/\" \/>\n<meta property=\"og:site_name\" content=\"VPasCode\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Tempo estimado de leitura\" \/>\n\t<meta name=\"twitter:data1\" content=\"3 minutos\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/www.vpascode.com\\\/pt\\\/docs\\\/vpascode-docs\\\/plantuml-syntax-basics\\\/\",\"url\":\"https:\\\/\\\/www.vpascode.com\\\/pt\\\/docs\\\/vpascode-docs\\\/plantuml-syntax-basics\\\/\",\"name\":\"PlantUML Syntax Basics | VPasCode Text to Diagram Guide\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/www.vpascode.com\\\/pt\\\/#website\"},\"datePublished\":\"2026-05-26T06:46:41+00:00\",\"description\":\"Master PlantUML syntax fundamentals in VPasCode, a versatile diagram-as-code tool to convert text to diagram architecture maps.\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/www.vpascode.com\\\/pt\\\/docs\\\/vpascode-docs\\\/plantuml-syntax-basics\\\/#breadcrumb\"},\"inLanguage\":\"pt-PT\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/www.vpascode.com\\\/pt\\\/docs\\\/vpascode-docs\\\/plantuml-syntax-basics\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/www.vpascode.com\\\/pt\\\/docs\\\/vpascode-docs\\\/plantuml-syntax-basics\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/www.vpascode.com\\\/pt\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Lean Docs\",\"item\":\"https:\\\/\\\/www.vpascode.com\\\/pt\\\/docs\\\/%ld_collection%\\\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"No\u00e7\u00f5es B\u00e1sicas da Sintaxe do PlantUML\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/www.vpascode.com\\\/pt\\\/#website\",\"url\":\"https:\\\/\\\/www.vpascode.com\\\/pt\\\/\",\"name\":\"VPasCode\",\"description\":\"by Visual Paradigm\",\"publisher\":{\"@id\":\"https:\\\/\\\/www.vpascode.com\\\/pt\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/www.vpascode.com\\\/pt\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"pt-PT\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/www.vpascode.com\\\/pt\\\/#organization\",\"name\":\"VPasCode\",\"url\":\"https:\\\/\\\/www.vpascode.com\\\/pt\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"pt-PT\",\"@id\":\"https:\\\/\\\/www.vpascode.com\\\/pt\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/www.vpascode.com\\\/pt\\\/wp-content\\\/uploads\\\/sites\\\/10\\\/2026\\\/06\\\/cropped-vp-online-logo-v1.png\",\"contentUrl\":\"https:\\\/\\\/www.vpascode.com\\\/pt\\\/wp-content\\\/uploads\\\/sites\\\/10\\\/2026\\\/06\\\/cropped-vp-online-logo-v1.png\",\"width\":128,\"height\":138,\"caption\":\"VPasCode\"},\"image\":{\"@id\":\"https:\\\/\\\/www.vpascode.com\\\/pt\\\/#\\\/schema\\\/logo\\\/image\\\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"PlantUML Syntax Basics | VPasCode Text to Diagram Guide","description":"Master PlantUML syntax fundamentals in VPasCode, a versatile diagram-as-code tool to convert text to diagram architecture maps.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.vpascode.com\/pt\/docs\/vpascode-docs\/plantuml-syntax-basics\/","og_locale":"pt_PT","og_type":"article","og_title":"PlantUML Syntax Basics | VPasCode Text to Diagram Guide","og_description":"Master PlantUML syntax fundamentals in VPasCode, a versatile diagram-as-code tool to convert text to diagram architecture maps.","og_url":"https:\/\/www.vpascode.com\/pt\/docs\/vpascode-docs\/plantuml-syntax-basics\/","og_site_name":"VPasCode","twitter_card":"summary_large_image","twitter_misc":{"Tempo estimado de leitura":"3 minutos"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.vpascode.com\/pt\/docs\/vpascode-docs\/plantuml-syntax-basics\/","url":"https:\/\/www.vpascode.com\/pt\/docs\/vpascode-docs\/plantuml-syntax-basics\/","name":"PlantUML Syntax Basics | VPasCode Text to Diagram Guide","isPartOf":{"@id":"https:\/\/www.vpascode.com\/pt\/#website"},"datePublished":"2026-05-26T06:46:41+00:00","description":"Master PlantUML syntax fundamentals in VPasCode, a versatile diagram-as-code tool to convert text to diagram architecture maps.","breadcrumb":{"@id":"https:\/\/www.vpascode.com\/pt\/docs\/vpascode-docs\/plantuml-syntax-basics\/#breadcrumb"},"inLanguage":"pt-PT","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.vpascode.com\/pt\/docs\/vpascode-docs\/plantuml-syntax-basics\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.vpascode.com\/pt\/docs\/vpascode-docs\/plantuml-syntax-basics\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.vpascode.com\/pt\/"},{"@type":"ListItem","position":2,"name":"Lean Docs","item":"https:\/\/www.vpascode.com\/pt\/docs\/%ld_collection%\/"},{"@type":"ListItem","position":3,"name":"No\u00e7\u00f5es B\u00e1sicas da Sintaxe do PlantUML"}]},{"@type":"WebSite","@id":"https:\/\/www.vpascode.com\/pt\/#website","url":"https:\/\/www.vpascode.com\/pt\/","name":"VPasCode","description":"by Visual Paradigm","publisher":{"@id":"https:\/\/www.vpascode.com\/pt\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.vpascode.com\/pt\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"pt-PT"},{"@type":"Organization","@id":"https:\/\/www.vpascode.com\/pt\/#organization","name":"VPasCode","url":"https:\/\/www.vpascode.com\/pt\/","logo":{"@type":"ImageObject","inLanguage":"pt-PT","@id":"https:\/\/www.vpascode.com\/pt\/#\/schema\/logo\/image\/","url":"https:\/\/www.vpascode.com\/pt\/wp-content\/uploads\/sites\/10\/2026\/06\/cropped-vp-online-logo-v1.png","contentUrl":"https:\/\/www.vpascode.com\/pt\/wp-content\/uploads\/sites\/10\/2026\/06\/cropped-vp-online-logo-v1.png","width":128,"height":138,"caption":"VPasCode"},"image":{"@id":"https:\/\/www.vpascode.com\/pt\/#\/schema\/logo\/image\/"}}]}},"_links":{"self":[{"href":"https:\/\/www.vpascode.com\/pt\/wp-json\/wp\/v2\/ld_docs\/2130","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.vpascode.com\/pt\/wp-json\/wp\/v2\/ld_docs"}],"about":[{"href":"https:\/\/www.vpascode.com\/pt\/wp-json\/wp\/v2\/types\/ld_docs"}],"author":[{"embeddable":true,"href":"https:\/\/www.vpascode.com\/pt\/wp-json\/wp\/v2\/users\/4"}],"wp:attachment":[{"href":"https:\/\/www.vpascode.com\/pt\/wp-json\/wp\/v2\/media?parent=2130"}],"wp:term":[{"taxonomy":"ld_collection","embeddable":true,"href":"https:\/\/www.vpascode.com\/pt\/wp-json\/wp\/v2\/ld_collection?post=2130"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}