Исходный код вики Мелкие моменты работы с кодом для удобства

Редактировал(а) Alexandr Fokin 2025/03/17 13:07

version	line-number	content
1.10	1	\|(% style="width:37px" %)1\|(% style="width:231px" %)Структура метода.
1.11	2	\|(% style="width:1217px" %)(((
	3	Работа со scope, выделение смысловых блоков.
	4
1.3	5	Замечание: не всегда все удобно укладывается именно в такой набор блоков, тут скорее про сам принцип.
1.1	6	Учитывать также удобство, читаемость, объемность, перегруженность. Не противоречит вынесению некоторых частей в отдельные методы.
1.3	7	)))\|(% style="width:1217px" %){{code language="c#"}}class MyClass
1.1	8	{
	9	public void MyMethod()
1.7	10	{
	11	// 1) Блока загрузки данных
1.1	12	// Переменные данных
	13	{
	14	// локальные переменные блока
	15	}
	16
1.7	17	// 2.1) Блок обработки 1
1.1	18	{
	19	// локальные переменные блока
	20	}
	21
1.7	22	// 2.N Блок обработки N
1.1	23	{
	24	// локальные переменные блока
	25	}
	26	}
1.3	27	}{{/code}}
1.6	28	\|(% style="width:37px" %)2\|(% style="width:231px" %)Именование сущностей\|(% style="width:1217px" %)Использовать тип в наименованиях, в том числе для entity, dto и других.
3.2	29	1) По названию всегд видно тип.
	30	2) Не случиться так, что сегмент namespace и тип называются одинаково.\|(% style="width:1217px" %)ClientEntity, AccountEntity.
1.3	31	\|(% style="width:37px" %)3\|(% style="width:231px" %)Комментарии\|(% style="width:1217px" %)Указывать в комментариях ссылки на документацию, схемы.(((
	32	1. Описание структуры entity - таблицы, описание dto - контракта.
1.1	33	1. Описание логики сценария, маппинга.
1.3	34	1. Ссылка на Т.З.
1.9	35
3.1	36	[[Описание и модель приложения>>doc:Архитектура и модели.Про приложение.Описание и модель системы.WebHome]]
1.3	37	)))\|(% style="width:1217px" %)
	38	\|(% style="width:37px" %) \|(% style="width:231px" %) \|(% style="width:1217px" %) \|(% style="width:1217px" %)