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