Hướng dẫn này bao gồm sáu thành phần được sử dụng nhiều nhấtvăn bản và chú thíchtrong PlantUML. Trong mọi ví dụ, tôi áp dụng các quy ước nội bộ: skinparam defaultFontSize 14 và skinparam defaultFontColor #333333ở đầu tệp.
Định hướng nhanh về vị trí của từng thành phần so với phần thân sơ đồ:
| Thành phần | Vị trí trên hình ảnh được render | Khối nhiều dòng? | Mục đích |
|---|---|---|---|
title |
Trung tâm phía trên | Có (end title) |
Tên sơ đồ / phiên bản |
header |
Phía trên sơ đồ (đầu trang) | Có (endheader) |
Bối cảnh, tên tổ chức, phân loại |
footer |
Phía dưới sơ đồ (chân trang) | Có (endfooter) |
Tác giả, công cụ, dấu thời gian |
chú thích |
Ngay bên dưới sơ đồ | Không (một dòng) | Đánh số hình |
bảng chú giải |
Góc của sơ đồ | Có (kết thúc bảng chú giải) |
Chìa khóa ký hiệu / giải mã |
ghi chú |
Gắn vào hoặc nổi gần các phần tử | Cả hai dạng | Bình luận về một phần tử cụ thể |
1. Tiêu đề
Tiêu đề sơ đồ nằm căn giữa ở phía trên. Nó hỗ trợ định dạng nội tuyến (<size>, <b>, <color>, <u>, <i>) và dạng nhiều dòng.
Dạng đơn giản:
title Dịch vụ Xử lý Đơn hàng
Dạng nhiều dòng có định dạng:
title
<size=20><b>Dịch vụ Xử lý Đơn hàng</b></size>
<size=14><color=#555555>Sơ đồ Ngữ cảnh - v1.0</color></size>
endtitle
Với mẫu phụ đề: PlantUML không có từ khóa phụ đề chuyên dụng, vì vậy hãy mô phỏng nó bằng một dòng thứ hai nhỏ hơn như đã hiển thị ở trên.
Những lỗi phổ biến
-
tiêu đềkhông cóend titlelà ổn chỉ cho một dòng đơn. Nếu bạn viết bất cứ điều gì trên dòng tiếp theo, PlantUML sẽ coi đó là một phần của tiêu đề chỉ khi bạn đã mở một khối bằngend title. -
Các thẻ HTML nội tuyến phải được đóng (
<b>...</b>) hoặc việc hiển thị sẽ không thể đoán trước. -
Tiêu đề là một phần của sơ đồ, vì vậy nó sẽ xuất hiện trong các bản xuất — đừng sao chép nó vào chú thích tên tệp.
2. Phần đầu
Phần đầu được hiển thị phía trênthân sơ đồ, tách biệt với nó. Hãy sử dụng nó cho ngữ cảnh tổ chức, biểu ngữ phân loại hoặc mã tài liệu. Dạng đơn dòng hoặc khối:
header Hội đồng Đánh giá Kiến trúc - Nội bộ
header
<font color=#777777 size=12>Hội đồng Đánh giá Kiến trúc</font>
endheader
Khi nào sử dụng phần đầu so với tiêu đề: phần tiêu đề mô tả sơ đồ là gì; phần phần đầu mô tả bối cảnh tài liệu mà nó thuộc về (tổ chức, mức độ bảo mật, phiên bản phát hành). Việc giữ chúng riêng biệt cho phép bạn đóng dấu nhiều sơ đồ cùng một tiêu đề.
3. Chân trang
Chân trang phản chiếu tiêu đề ở phía dưới. Lý tưởng cho thông tin tác giả, công cụ và dấu thời gian.
footer Được chuẩn bị bằng Visual Paradigm VPasCode
footer
<font color=#777777 size=11>Được chuẩn bị bằng Visual Paradigm VPasCode - Tạo năm 2025</font>
endfooter
Mẹo: PlantUML thay thế %date% (và %time%) bên trong văn bản tiêu đề/chân trang/tiêu đề, điều này rất hữu ích cho các bản xuất có đóng dấu:
footer Đã hiển thị %date%
4. Chú thích
Một chú thích là một dòng đơn được đặt ngay bên dưới sơ đồ. Đây là vị trí chuẩn mực để đánh số hình trong tài liệu (tự nhiên đi kèm với một tiêu đề ở phía trên).
caption Hình 1. Dịch vụ đơn hàng và các cộng tác viên của nó
Khác với tiêu đề/tiêu đề trang/chân trang, chú thích chỉ nhận một dòng — không có kết thúc chú thích khối là cần thiết hoặc được mong đợi. Hãy giữ nó ngắn gọn và theo phong cách tham chiếu.
5. Chú giải
Chú giải là một khung khóa được hiển thị ở một góc của sơ đồ. Nó chấp nhận văn bản giàu định dạng và cú pháp bảng đơn giản (| | ô). Vị trí được điều khiển bằng một từ khóa: trên, dưới, trái, phải, hoặc giữa.
chú giải phải
|= Trạng thái |= Ý nghĩa |
| Mới | Đã tạo, chưa thanh toán |
| Đã thanh toán | Đã thu tiền |
| Đã giao | Đã giao cho đơn vị vận chuyển |
kết thúc chú giải
Tùy chọn định vị
chú giải trên trái
Mũi liền = gọi đồng bộ
Mũi đứt = sự kiện bất đồng bộ
kết thúc chú giải
Khi nào nên dùng chú giải thay vì ghi chú: một chú giải giải mã ký hiệu được sử dụng trên toàn bộ sơ đồ (ý nghĩa của một ký hiệu, kiểu đường hoặc màu). Một ghi chú bình luận về một yếu tố cụ thể. Nếu người đọc phải tra cứu một ký hiệu ở nhiều hơn một vị trí, hãy nâng nó lên thành chú giải.
6. Ghi chú
Ghi chú gắn nhận xét vào một phần tử đơn lẻ hoặc tự do trôi nổi. Có ba kiểu gọi.
Ghi chú một dòng gắn vào một phần tử:
note top of Order : Ghi chú trôi nổi một dòng
Ghi chú nhiều dòng gắn vào một phần tử:
note right of Order
Ghi chú nhiều dòng
với định dạng tự do **formatting**
end note
Ghi chú độc lập (trôi nổi): gán cho nó một biệt danh để sau này có thể liên kết hoặc định vị.
note "Ghi chú độc lập neo qua biệt danh" as N1
Từ khóa định vị cho ghi chú gắn: trên, dưới, trái, phải của <phần tử>. Bạn có thể kết hợp hai hướng trong các phiên bản mới hơn (ví dụ: note top left of), nhưng định vị theo một hướng là khả năng di động nhất.
Cạm bẫy
-
Dạng một dòng sau
:chỉ dành cho một dòng — hãy sử dụngend notekhối cho nhiều dòng. -
Bên trong
end notecác khối, định dạng nội tuyến tiêu chuẩn và ngay cả các biểu đồ/con biểu đồ nhúng đều hoạt động; tránh các dấu ngoặc kép ” chưa được thoát bị sót lại--mà một số trình phân tích đọc là ký tự phân tách.
7. Kết hợp tất cả lại với nhau
Phần sau đây được xác thực sạch sẽ và minh họa tất cả các yếu tố trong một biểu đồ. Lưu ý: tiêu đề đầu/tiêu đề cuối/tiêu đề/chú thích khung biểu đồ từ ngoài vào trong, trong khi các chú giải và ghi chú sống bên trong vùng vẽ biểu đồ.
@startuml
skinparam defaultFontSize 14
skinparam defaultFontColor #333333
header Hội đồng xem xét kiến trúc - Nội bộ
title Dịch vụ xử lý đơn hàng - Biểu đồ ngữ cảnh v1.0
caption Hình 1. Dịch vụ đơn hàng và các đối tác cộng tác của nó
footer Được chuẩn bị bằng Visual Paradigm VPasCode
actor Khách hàng
component WebApp
component OrderSvc
database OrderDB
Khách hàng --> WebApp
WebApp --> OrderSvc
OrderSvc --> OrderDB
ghi chú bên phải của OrderSvc
Xác thực đơn hàng,
sau đó lưu vào OrderDB.
end ghi chú
chú giải bên phải
|= Mũi tên |= Ý nghĩa |
| --> | Gọi đồng bộ |
| ...> | Sự kiện bất đồng bộ |
end chú giải
@endumlTài liệu hóa & Hiển thị bằng Visual Paradigm VPasCode
Dán bất kỳ phần đầy đủ nào trong @startuml … @enduml các tệp ở trên vào Visual Paradigm VPasCode và nó sẽ hiển thị biểu đồ, áp dụng chủ đề VP, và cho phép bạn xuất sang PNG/SVG/PDF. Chủ đề VP cũng có thể được lồng vào một cách rõ ràng ở đầu biểu đồ:
!include https://static.visual-paradigm.com/web/resources/plantuml-stdlib/themes/vp.puml
skinparam vpDiagramType ComponentDiagram
Bạn có thể xem và hiển thị những thứ này trực tuyến tại https://www.vpascode.com. Sắp xếp mẫu cơ sở của bạn một cách nhất quán — tiêu đề và chú thích cho danh tính của hình, tiêu đề/chân trang cho ngữ cảnh tài liệu, bảng chú giải để giải mã ký hiệu, ghi chú cho nhận xét theo từng thành phần — và các sơ đồ của bạn sẽ đọc như một bộ thống nhất, được xuất bản một cách chuyên nghiệp.
This post is also available in English, Español, Français, Bahasa Indonesia, 日本語, Polski, Portuguese, Ру́сский, 简体中文 and 繁體中文.