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

Pf2eModel/Model/Structure/SpellRelation/SpellArea.cs

@@ -1,26 +1,49 @@
 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.SpellRelation;
 
+/// <summary>
+/// Область заклинания.
+/// </summary>
 public class SpellArea
 {
+    /// <summary>
+    /// Идентификатор области заклинания.
+    /// </summary>
     [Key]
     [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
     [Column(Order = 1)]
+    [Comment("Идентификатор")]
     public int Id { get; set; }
 
+    /// <summary>
+    /// Идентификатор заклинания, к которому относится область.
+    /// </summary>
     [Column(Order = 2)]
+    [Comment("Идентификатор заклинания")]
     public int SpellId { get; set; }
 
+    /// <summary>
+    /// Описание области заклинания.
+    /// </summary>
     [Column(Order = 3)]
     [MaxLength(255)]
+    [Comment("Описание области заклинания")]
     public LocaleString? Details { get; set; }
 
+    /// <summary>
+    /// Тип области заклинания.
+    /// </summary>
     [Column(Order = 4)]
+    [Comment("Тип области заклинания")]
     public SpellAreaType Type { get; set; }
 
+    /// <summary>
+    /// Заклинание, к которому относится область.
+    /// </summary>
     public virtual Spell Spell { get; set; } = null!;
 }

Pf2eModel/Model/Structure/SpellRelation/SpellDamage.cs

@@ -1,43 +1,86 @@
 using System.ComponentModel.DataAnnotations;
 using System.ComponentModel.DataAnnotations.Schema;
+using Microsoft.EntityFrameworkCore;
 using Pf2eModel.Model.Enum;
 
 namespace Pf2eModel.Model.Structure.SpellRelation;
 
+/// <summary>
+/// Урон заклинания.
+/// </summary>
 public class SpellDamage
 {
+    /// <summary>
+    /// Идентификатор урона заклинания.
+    /// </summary>
     [Key]
     [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
     [Column(Order = 1)]
+    [Comment("Идентификатор урона заклинания")]
     public int Id { get; set; }
 
+    /// <summary>
+    /// Идентификатор заклинания, к которому относится урон.
+    /// </summary>
     [Column(Order = 2)]
+    [Comment("Идентификатор заклинания")]
     public int SpellId { get; set; }
 
+    /// <summary>
+    /// Уровень заклинания, к которому относится урон.
+    /// </summary>
     [Column(Order = 3)]
     [MaxLength(255)]
+    [Comment("Уровень заклинания")]
     public string Key { get; set; } = null!;
 
+    /// <summary>
+    /// Применяется ли модификатор к урону заклинания.
+    /// </summary>
     [Column(Order = 4)]
+    [Comment("Применяется модификатор?")]
     public bool? ApplyMod { get; set; }
 
+    /// <summary>
+    /// Категория урона заклинания, если применимо.
+    /// </summary>
     [Column(Order = 5)]
+    [Comment("Категория урона заклинания")]
     public SpellDamageCategory? Category { get; set; }
 
+    /// <summary>
+    /// Формула урона заклинания.
+    /// </summary>
     [Column(Order = 6)]
     [MaxLength(255)]
+    [Comment("Формула урона заклинания")]
     public string Formula { get; set; } = null!;
 
+    /// <summary>
+    /// Тип урона заклинания.
+    /// </summary>
     [Column(Order = 7)]
+    [Comment("Тип урона заклинания")]
     public SpellDamageKinds Kinds { get; set; }
 
+    /// <summary>
+    /// Материалы, необходимые для заклинания, если применимо.
+    /// </summary>
     [Column(Order = 8)]
     [MaxLength(255)]
+    [Comment("Материалы для заклинания")]
     public string? Materials { get; set; }
 
+    /// <summary>
+    /// Тип урона заклинания, если применимо (например, "fire", "cold" и т.д.).
+    /// </summary>
     [Column(Order = 9)]
     [MaxLength(255)]
+    [Comment("Тип урона заклинания")]
     public string Type { get; set; } = null!;
 
+    /// <summary>
+    /// Заклинание, к которому относится урон.
+    /// </summary>
     public virtual Spell Spell { get; set; } = null!;
 }

Pf2eModel/Model/Structure/SpellRelation/SpellDefense.cs

@@ -1,27 +1,52 @@
 using System.ComponentModel.DataAnnotations;
 using System.ComponentModel.DataAnnotations.Schema;
+using Microsoft.EntityFrameworkCore;
 
 namespace Pf2eModel.Model.Structure.SpellRelation;
 
+/// <summary>
+/// Защита от заклинания.
+/// </summary>
 public class SpellDefense
 {
+    /// <summary>
+    /// Идентификатор защиты от заклинания.
+    /// </summary>
     [Key]
     [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
     [Column(Order = 1)]
+    [Comment("Идентификатор")]
     public int Id { get; set; }
 
+    /// <summary>
+    /// Идентификатор заклинания, к которому относится защита.
+    /// </summary>
     [Column(Order = 2)]
+    [Comment("Идентификатор заклинания")]
     public int SpellId { get; set; }
 
+    /// <summary>
+    /// Флаг, указывающий, является ли защита от заклинания пассивной (например, для заклинаний, которые не требуют активного действия для защиты).
+    /// </summary>
     [Column(Order = 3)]
     public bool IsPassive { get; set; }
 
+    /// <summary>
+    /// Флаг, указывающий, является ли защита базовой.
+    /// </summary>
     [Column(Order = 4)]
+    [Comment("Базовый спасборосок?")]
     public bool? IsBasic { get; set; }
 
+    /// <summary>
+    /// Статистика, используемая для защиты от заклинания (например, "Fortitude", "Reflex", "Will").
+    /// </summary>
     [Column(Order = 5)]
     [MaxLength(255)]
     public string Statistic { get; set; } = null!;
 
+    /// <summary>
+    /// Заклинание, к которому относится защита.
+    /// </summary>
     public virtual Spell Spell { get; set; } = null!;
 }