Документация проекта отображения.

Pf2eViewer/MainViewForm.cs

@@ -4,10 +4,19 @@ using Pf2eModel.Model.Enum;
 
 namespace Pf2eViewer;
 
+/// <summary>
+/// Основная форма приложения.
+/// </summary>
 public partial class MainViewForm : Form
 {
+    /// <summary>
+    /// Контекст базы данных.
+    /// </summary>
     public Pf2eDbContext Context = new();
 
+    /// <summary>
+    /// Элемент управления для отображения дерева сущностей.
+    /// </summary>
     [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
     public EntityView? CurrentView
     {
@@ -19,6 +28,9 @@ public partial class MainViewForm : Form
         }
     }
 
+    /// <summary>
+    /// Конструктор класса <see cref="MainViewForm"/>.
+    /// </summary>
     public MainViewForm()
     {
         InitializeComponent();
@@ -28,6 +40,9 @@ public partial class MainViewForm : Form
         Reset();
     }
 
+    /// <summary>
+    /// Сброс состояния формы.
+    /// </summary>
     public void Reset()
     {
         Context.Dispose();
@@ -41,6 +56,11 @@ public partial class MainViewForm : Form
         TypesListBox.SelectedIndex = 0;
     }
 
+    /// <summary>
+    /// Обработчик события изменения выбранного элемента в списке типов сущностей.
+    /// </summary>
+    /// <param name="sender">Источник события.</param>
+    /// <param name="_">Данные события.</param>
     private void TypesListBox_SelectedIndexChanged(object sender, EventArgs _)
     {
         if (TypesListBox.SelectedItem is null)
@@ -53,6 +73,10 @@ public partial class MainViewForm : Form
         DatabaseViewer.Type = (EntityType)TypesListBox.SelectedItem;
     }
 
+    /// <summary>
+    /// Обработчик события изменения выбранной сущности в дереве сущностей.
+    /// </summary>
+    /// <param name="newEntity">Новая выбранная сущность.</param>
     private void DatabaseViewer_EntityChange(EntityView newEntity)
     {
         CurrentView = newEntity;