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

Pf2eModel/Model/Structure/BackgroundRelation/BackgroundBoost.cs

@@ -1,23 +1,42 @@
 using System.ComponentModel.DataAnnotations;
 using System.ComponentModel.DataAnnotations.Schema;
+using Microsoft.EntityFrameworkCore;
 using Newtonsoft.Json;
 using Pf2eModel.Model.Enum;
 
 namespace Pf2eModel.Model.Structure.BackgroundRelation;
 
+/// <summary>
+/// Элемент набора атрибутов для предыстории.
+/// </summary>
 public class BackgroundBoost
 {
+    /// <summary>
+    /// Идентификатор элемента набора атрибутов для предыстории.
+    /// </summary>
     [Key]
     [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
     [Column(Order = 1)]
+    [Comment("Идентификатор")]
     public int Id { get; set; }
 
+    /// <summary>
+    /// Идентификатор предыстории, к которой относится этот элемент набора атрибутов.
+    /// </summary>
     [Column(Order = 2)]
+    [Comment("Идентификатор предыстории")]
     public int BackgroundId { get; set; }
 
+    /// <summary>
+    /// Атрибут, к которому относится этот элемент набора атрибутов для предыстории.
+    /// </summary>
     [Column(Order = 3)]
+    [Comment("Атрибут")]
     public AttributeValues Attribute { get; set; }
 
+    /// <summary>
+    /// Предыстория, к которой относится этот элемент набора атрибутов.
+    /// </summary>
     [JsonIgnore]
     public Background Background { get; set; } = null!;
 }

Pf2eModel/Model/Structure/BackgroundRelation/BackgroundItem.cs

@@ -5,20 +5,40 @@ using Pf2eModel.Model.Base;
 
 namespace Pf2eModel.Model.Structure.BackgroundRelation;
 
+/// <summary>
+/// Элемент предыстории, который может быть способностью, навыком или другим элементом, связанным с предысторией.
+/// </summary>
 [PrimaryKey(nameof(BackgroundId), nameof(EntityId))]
 public class BackgroundItem
 {
+    /// <summary>
+    /// Идентификатор элемента предыстории.
+    /// </summary>
     [Column(Order = 1)]
+    [Comment("Идентификатор")]
     public int BackgroundId { get; set; }
 
+    /// <summary>
+    /// Идентификатор сущности, связанной с предысторией.
+    /// </summary>
     [Column(Order = 2)]
+    [Comment("Идентификатор сущности")]
     public int EntityId { get; set; }
 
+    /// <summary>
+    /// Уровень элемента предыстории, если применимо. Может быть null, если уровень не указан или не применим.
+    /// </summary>
     [Column(Order = 3)]
     public int? Level { get; set; }
 
+    /// <summary>
+    /// Предыстория, к которой относится сущность.
+    /// </summary>
     [JsonIgnore]
     public Background Background { get; set; } = null!;
 
+    /// <summary>
+    /// Сущность, связанная с предысторией.
+    /// </summary>
     public Entity Entity { get; set; } = null!;
 }

Pf2eModel/Model/Structure/BackgroundRelation/BackgroundTraining.cs

@@ -1,29 +1,55 @@
 using System.ComponentModel.DataAnnotations;
 using System.ComponentModel.DataAnnotations.Schema;
+using Microsoft.EntityFrameworkCore;
 using Newtonsoft.Json;
 using Pf2eModel.Model.Common;
 using Pf2eModel.Model.Enum;
 
 namespace Pf2eModel.Model.Structure.BackgroundRelation;
 
+/// <summary>
+/// Элемент набора связей между предысторией и тренируемым навыком.
+/// </summary>
 public class BackgroundTraining
 {
+    /// <summary>
+    /// Идентификатор элемента набора связей между предысторией и тренируемым навыком.
+    /// </summary>
     [Key]
     [DatabaseGenerated(DatabaseGeneratedOption.None)]
     [Column(Order = 1)]
+    [Comment("Идентификатор")]
     public int Id { get; set; }
 
+    /// <summary>
+    /// Идентификатор предыстории, к которой относится тренировка.
+    /// </summary>
     [Column(Order = 2)]
+    [Comment("Идентификатор предыстории")]
     public int BackgroundId { get; set; }
 
+    /// <summary>
+    /// Идентификатор тренируемого навыка.
+    /// </summary>
     [Column(Order = 3)]
+    [Comment("Идентификатор тренируемого навыка")]
     public int TrainingId { get; set; }
 
+    /// <summary>
+    /// Ранг тренировки, который получает персонаж при выборе данной предыстории.
+    /// </summary>
     [Column(Order = 4)]
+    [Comment("Ранг тренировки")]
     public TrainingRank Rank { get; set; }
 
+    /// <summary>
+    /// Предыстория, к которой относится тренировка.
+    /// </summary>
     [JsonIgnore]
     public Background Background { get; set; } = null!;
 
+    /// <summary>
+    /// Тренируемый навык, который получает персонаж при выборе данной предыстории.
+    /// </summary>
     public Training Training { get; set; } = null!;
 }