Mermaid Sınıf Diyagramı Sözdizimi
Sınıf diyagramları, sınıfları, özelliklerini ve yöntemlerini ve aralarındaki ilişkileri haritalayarak bir sistemin yapısını gösterir. Nesne yönelimli tasarımları, API istemci kitaplıklarını ve alan modellerini belgelemek için standart UML diyagramıdır. Mermaid, bunları kodun kendisinin basitleştirilmiş bir versiyonu gibi okunan bir metin tanımından işler.
Sınıfları Tanımlama
classDiagram
class UserService {
-UserRepository repo
-Logger logger
+getUser(id) User
+createUser(data) User
+deleteUser(id) void
-validate(data) bool
}
Sınıf bloğunun içindeki her satır bir üyeyi tanımlar. Format alanlar için görünürlük ad tür ve yöntemler için görünürlük ad(parametreler) dönüşTürü şeklindedir.
İlişkiler
İlişkiler ok sözdizimi kullanılarak sınıflar arasına çizilir:
classDiagram
Animal <|-- Dog : extends
Animal <|-- Cat : extends
Dog *-- Leg : has
Owner o-- Pet : owns
Kennel --> Dog : houses
Animal ..> Food : depends on
İlişki Türleri
| Sözdizimi | Tür | Anlamı |
|---|---|---|
| `A < | — B` | Kalıtım |
| `A < | .. B` | Gerçekleme |
A *-- B | Kompozisyon | B, A’nın parçasıdır, yaşam döngüsü bağlı |
A o-- B | Toplama | B, A’ya aittir, yalnız var olabilir |
A --> B | İlişkilendirme | A, B’ye başvurur |
A ..> B | Bağımlılık | A, B’yi geçici olarak kullanır |
Ek Açıklamalar
Sınıfları soyut, arayüz, numaralandırma veya herhangi bir özel stereotip olarak işaretleyin:
classDiagram
class Shape {
<<abstract>>
+area() double
+perimeter() double
}
class Drawable {
<<interface>>
+draw(canvas) void
}
Jenerikler
Açılı parantezler yerine tilde kullanın:
classDiagram
class Repository~T~ {
+findById(id) T
+save(entity T) T
}
Bu sınıfların çalışma zamanında nasıl etkileşime girdiğini belgelemek için Mermaid Sıra Diyagramı aracını kullanın.