Сценарии - Мелкие моменты работы с кодом для удобства 

Page / - Изменено Alexandr Fokin в 2025/01/11 15:04 

Мелкие моменты работы с кодом для удобства 
Изменено Alexandr Fokin
в 2025/01/11 15:04

Оглавление

1	Структура метода.
 	Работа со scope, выделение смысловых блоков.
Замечание: не всегда все удобно укладывается именно в такой набор блоков, тут скорее про сам принцип.
Учитывать также удобство, читаемость, объемность, перегруженность. Не противоречит вынесению некоторых частей в отдельные методы.	class MyClass
{
 public void MyMethod()
  {  
   // 1) Блока загрузки данных
   // Переменные данных
   {
    // локальные переменные блока
   }
   
   // 2.1) Блок обработки 1
   {
    // локальные переменные блока
   }
   
   // 2.N Блок обработки N
   {
    // локальные переменные блока
   }
  }
}	
2	Именование сущностей	Использовать тип в наименованиях, в том числе для entity, dto и других.
1) По названию всегд видно тип.
2) Не случиться так, что сегмент namespace и тип называются одинаково.	ClientEntity, AccountEntity.	
3	Комментарии	Указывать в комментариях ссылки на документацию, схемы.
 1.	Описание структуры entity - таблицы, описание dto - контракта.
 2.	Описание логики сценария, маппинга.
 3.	Ссылка на Т.З.
Описание и модель приложения