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