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

Pf2eModel/Model/Structure/DeityRelation/DeityAttribute.cs

@@ -4,14 +4,28 @@ using Pf2eModel.Model.Enum;
 
 namespace Pf2eModel.Model.Structure.DeityRelation;
 
+/// <summary>
+/// Элемент отношения божества и атрибута.
+/// </summary>
 [PrimaryKey(nameof(DeityId), nameof(Attribute))]
 public class DeityAttribute
 {
+    /// <summary>
+    /// Идентификатор божества.
+    /// </summary>
     [Column(Order = 1)]
+    [Comment("Идентификатор божества")]
     public int DeityId { get; set; }
 
+    /// <summary>
+    /// Атрибут божества.
+    /// </summary>
     [Column(Order = 2)]
+    [Comment("Атрибут божества")]
     public AttributeValues Attribute { get; set; }
 
+    /// <summary>
+    /// Божество, к которому относится атрибут.
+    /// </summary>
     public Deity Deity { get; set; } = null!;
 }

Pf2eModel/Model/Structure/DeityRelation/DeityDomain.cs

@@ -1,24 +1,46 @@
 using System.ComponentModel.DataAnnotations;
 using System.ComponentModel.DataAnnotations.Schema;
+using Microsoft.EntityFrameworkCore;
 
 namespace Pf2eModel.Model.Structure.DeityRelation;
 
+/// <summary>
+/// Элемент отношения божества и домена.
+/// </summary>
 public class DeityDomain
 {
+    /// <summary>
+    /// Идентификатор отношения божества и домена.
+    /// </summary>
     [Key]
     [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
     [Column(Order = 1)]
+    [Comment("Идентификатор")]
     public int Id { get; set; }
 
+    /// <summary>
+    /// Идентификатор божества, к которому относится домен.
+    /// </summary>
     [Column(Order = 2)]
+    [Comment("Идентификатор божества")]
     public int DeityId { get; set; }
 
+    /// <summary>
+    /// Флаг, указывающий, является ли домен основным для божества.
+    /// </summary>
     [Column(Order = 3)]
+    [Comment("Флаг основного домена")]
     public bool IsPrimary { get; set; }
 
+    /// <summary>
+    /// Значение домена божества, например, "Свет", "Тьма" и т.д.
+    /// </summary>
     [Column(Order = 4)]
     [MaxLength(Pf2eDbContext.NameLength)]
     public string Value { get; set; } = null!;
 
+    /// <summary>
+    /// Божество, к которому относится домен.
+    /// </summary>
     public virtual Deity Deity { get; set; } = null!;
 }

Pf2eModel/Model/Structure/DeityRelation/DeitySpell.cs

@@ -1,25 +1,51 @@
 using System.ComponentModel.DataAnnotations;
 using System.ComponentModel.DataAnnotations.Schema;
+using Microsoft.EntityFrameworkCore;
 
 namespace Pf2eModel.Model.Structure.DeityRelation;
 
+/// <summary>
+/// Связь божества и заклинания.
+/// </summary>
 public class DeitySpell
 {
+    /// <summary>
+    /// Идентификатор связи божества и заклинания.
+    /// </summary>
     [Key]
     [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
     [Column(Order = 1)]
+    [Comment("Идентификатор")]
     public int Id { get; set; }
 
+    /// <summary>
+    /// Идентификатор божества, к которому относится заклинание.
+    /// </summary>
     [Column(Order = 2)]
+    [Comment("Идентификатор божества")]
     public int DeityId { get; set; }
 
+    /// <summary>
+    /// Уровень заклинания.
+    /// </summary>
     [Column(Order = 3)]
+    [Comment("Уровень заклинания")]
     public int Level { get; set; }
 
+    /// <summary>
+    /// Идентификатор заклинания, связанного с божеством.
+    /// </summary>
     [Column(Order = 4)]
+    [Comment("Идентификатор заклинания")]
     public int SpellId { get; set; }
 
+    /// <summary>
+    /// Божество, к которому относится заклинание.
+    /// </summary>
     public virtual Deity Deity { get; set; } = null!;
 
+    /// <summary>
+    /// Заклинание, связанное с божеством.
+    /// </summary>
     public virtual Spell Spell { get; set; } = null!;
 }

Pf2eModel/Model/Structure/DeityRelation/DeityWeapon.cs

@@ -1,21 +1,40 @@
 using System.ComponentModel.DataAnnotations;
 using System.ComponentModel.DataAnnotations.Schema;
+using Microsoft.EntityFrameworkCore;
 
 namespace Pf2eModel.Model.Structure.DeityRelation;
 
+/// <summary>
+/// Связь божества с оружием.
+/// </summary>
 public class DeityWeapon
 {
+    /// <summary>
+    /// Идентификатор связи божества с оружием.
+    /// </summary>
     [Key]
     [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
     [Column(Order = 1)]
+    [Comment("Идентификатор")]
     public int Id { get; set; }
 
+    /// <summary>
+    /// Идентификатор божества, к которому относится оружие.
+    /// </summary>
     [Column(Order = 2)]
+    [Comment("Идентификатор божества")]
     public int DeityId { get; set; }
 
+    /// <summary>
+    /// Название оружия, связанного с божеством. Будет изменено на идентификатор оружия в будущем, когда будет реализована система оружия.
+    /// </summary>
     [Column(Order = 3)]
     [MaxLength(Pf2eDbContext.NameLength)]
+    [Comment("Название оружия")]
     public string Weapon { get; set; } = null!;
 
+    /// <summary>
+    /// Божество, к которому относится оружие.
+    /// </summary>
     public virtual Deity Deity { get; set; } = null!;
 }