Создание документации

Pf2eModel/Model/Structure/RitualRelation/RitualArea.cs

@@ -1,23 +1,42 @@
 using System.ComponentModel.DataAnnotations;
 using System.ComponentModel.DataAnnotations.Schema;
+using Microsoft.EntityFrameworkCore;
 using Pf2eModel.Model.Common.I18n;
 using Pf2eModel.Model.Enum;
 
 namespace Pf2eModel.Model.Structure.RitualRelation;
 
+/// <summary>
+/// Область действия ритуала.
+/// </summary>
 public class RitualArea
 {
+    /// <summary>
+    /// Идентификатор ритуала, к которому относится область действия.
+    /// </summary>
     [Key]
     [DatabaseGenerated(DatabaseGeneratedOption.None)]
     [Column(Order = 1)]
+    [Comment("Идентификатор ритуала")]
     public int RitualId { get; set; }
 
+    /// <summary>
+    /// Описание области действия ритуала.
+    /// </summary>
     [Column(Order = 2)]
     [MaxLength(255)]
+    [Comment("Описание области действия ритуала")]
     public LocaleString? Details { get; set; }
 
+    /// <summary>
+    /// Тип области действия ритуала.
+    /// </summary>
     [Column(Order = 3)]
+    [Comment("Тип области действия ритуала")]
     public SpellAreaType Type { get; set; }
 
+    /// <summary>
+    /// Ритуал, к которому относится область действия.
+    /// </summary>
     public virtual Ritual Ritual { get; set; } = null!;
 }

Pf2eModel/Model/Structure/RitualRelation/RitualCheck.cs

@@ -1,34 +1,68 @@
 using System.ComponentModel.DataAnnotations;
 using System.ComponentModel.DataAnnotations.Schema;
+using Microsoft.EntityFrameworkCore;
 using Pf2eModel.Model.Common;
 using Pf2eModel.Model.Common.I18n;
 using Pf2eModel.Model.Enum;
 
 namespace Pf2eModel.Model.Structure.RitualRelation;
 
+/// <summary>
+/// Проверка для ритуала.
+/// </summary>
 public class RitualCheck
 {
+    /// <summary>
+    /// Идентификатор проверки ритуала.
+    /// </summary>
     [Key]
     [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
     [Column(Order = 1)]
+    [Comment("Идентификатор")]
     public int Id { get; set; }
 
+    /// <summary>
+    /// Идентификатор ритуала, к которому относится проверка.
+    /// </summary>
     [Column(Order = 2)]
+    [Comment("Идентификатор ритуала")]
     public int RitualId { get; set; }
 
-    public Ritual Ritual { get; set; } = null!;
-
+    /// <summary>
+    /// Идентификатор тренировки, связанной с проверкой ритуала.
+    /// </summary>
     [Column(Order = 3)]
+    [Comment("Идентификатор тренировки")]
     public int? TrainingId { get; set; }
 
-    public Training? Training { get; set; } = null!;
-
+    /// <summary>
+    /// Дополнение к проверке.
+    /// </summary>
     [Column(Order = 4)]
+    [Comment("Дополнение к проверке")]
     public LocaleString? TrainingString { get; set; } = null;
 
+    /// <summary>
+    /// Ранг тренировки, связанной с проверкой ритуала.
+    /// </summary>
     [Column(Order = 5)]
+    [Comment("Ранг тренировки")]
     public TrainingRank Rank { get; set; }
 
+    /// <summary>
+    /// Флаг, указывающий, является ли проверка основной для ритуала.
+    /// </summary>
     [Column(Order = 6)]
+    [Comment("Флаг основной проверки")]
     public bool IsPrimary { get; set; }
+
+    /// <summary>
+    /// Ритуал, к которому относится проверка.
+    /// </summary>
+    public Ritual Ritual { get; set; } = null!;
+
+    /// <summary>
+    /// Тренировка, связанная с проверкой ритуала.
+    /// </summary>
+    public Training? Training { get; set; } = null!;
 }