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

Pf2eModel/Model/Structure/AncestryRelation/AncestryBoost.cs

@@ -1,25 +1,47 @@
 using System.ComponentModel.DataAnnotations;
 using System.ComponentModel.DataAnnotations.Schema;
+using Microsoft.EntityFrameworkCore;
 using Newtonsoft.Json;
 
 namespace Pf2eModel.Model.Structure.AncestryRelation;
 
+/// <summary>
+/// Элемент набора повышений атрибутов для родословной.
+/// </summary>
 public class AncestryBoost
 {
+    /// <summary>
+    /// Идентификатор элемента.
+    /// </summary>
     [Key]
     [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
     [Column(Order = 1)]
     public int Id { get; set; }
 
+    /// <summary>
+    /// Идентификатор родословной, к которой относится этот элемент.
+    /// </summary>
     [Column(Order = 2)]
+    [Comment("Идентификатор родословной")]
     public int AncestryId { get; set; }
 
+    /// <summary>
+    /// Указывает, является ли этот элемент повышением атрибута. Если <c>false</c> - это снижение атрибута.
+    /// </summary>
     [Column(Order = 3)]
+    [Comment("Флаг повышения/снижения")]
     public bool Boost { get; set; } = true;
 
+    /// <summary>
+    /// Значение атрибута, которое повышается или понижается в этом элементе набора повышений атрибутов.
+    /// </summary>
     [Column(Order = 4)]
+    [Comment("Значение атрибута")]
     public Enum.AttributeValues Value { get; set; }
 
+    /// <summary>
+    /// Родословная, к которой относится этот элемент набора повышений атрибутов.
+    /// </summary>
     [JsonIgnore]
     public Ancestry Ancestry { get; set; } = null!;
 }

Pf2eModel/Model/Structure/AncestryRelation/AncestryItem.cs

@@ -4,19 +4,40 @@ using Pf2eModel.Model.Base;
 
 namespace Pf2eModel.Model.Structure.AncestryRelation;
 
+/// <summary>
+/// Связь между родословной и сущностью.
+/// </summary>
 [PrimaryKey(nameof(AncestryId), nameof(ItemId))]
 public class AncestryItem
 {
+    /// <summary>
+    /// Идентификатор родословной.
+    /// </summary>
     [Column(Order = 1)]
+    [Comment("Идентификатор родословной")]
     public int AncestryId { get; set; }
 
+    /// <summary>
+    /// Идентификатор сущности, связанной с родословной.
+    /// </summary>
     [Column(Order = 2)]
+    [Comment("Идентификатор связанной сущности")]
     public int ItemId { get; set; }
 
+    /// <summary>
+    /// Уровень сущности в родословной.
+    /// </summary>
     [Column(Order = 3)]
+    [Comment("Уровень сущности в родословной")]
     public int Level { get; set; }
 
+    /// <summary>
+    /// Родословная, к которой относится сущность.
+    /// </summary>
     public Ancestry Ancestry { get; set; } = null!;
 
+    /// <summary>
+    /// Сущность, связанная с родословной.
+    /// </summary>
     public Entity Item { get; set; } = null!;
 }

Pf2eModel/Model/Structure/AncestryRelation/AncestryLanguage.cs

@@ -3,19 +3,40 @@ using Microsoft.EntityFrameworkCore;
 
 namespace Pf2eModel.Model.Structure.AncestryRelation;
 
+/// <summary>
+/// Связь между родословной и языком.
+/// </summary>
 [PrimaryKey(nameof(AncestryId), nameof(LanguageId))]
 public class AncestryLanguage
 {
+    /// <summary>
+    /// Идентификатор родословной, к которой относится язык.
+    /// </summary>
     [Column(Order = 1)]
+    [Comment("Идентификатор родословной")]
     public int AncestryId { get; set; }
 
+    /// <summary>
+    /// Идентификатор языка, связанного с родословной.
+    /// </summary>
     [Column(Order = 2)]
+    [Comment("Идентификатор связанного языка")]
     public int LanguageId { get; set; }
 
+    /// <summary>
+    /// Является ли язык дополнительным для родословной.
+    /// </summary>
     [Column(Order = 3)]
+    [Comment("Флаг дополнительного")]
     public bool IsAdditional { get; set; }
 
+    /// <summary>
+    /// Родословная, к которой относится язык.
+    /// </summary>
     public Ancestry Ancestry { get; set; } = null!;
 
+    /// <summary>
+    /// Язык, связанный с родословной.
+    /// </summary>
     public Language Language { get; set; } = null!;
 }