Количество параметров в методе, однострочные конструкции, аннотация методов #8
Conversation
| @@ -83,6 +82,45 @@ URLСервиса = ""; | |||
| // ИмяПользователя - Строка | |||
| // ПарольПользователя - Строка | |||
| ``` | |||
| - Не используйте в методе больше трех основных параметров. Структура дополнительных параметров определяется четвертым параметром | |||
There was a problem hiding this comment.
Спорный момент. Sandi Metz, достаточно известный и авторитетный разработчик в своих правилах https://thoughtbot.com/blog/sandi-metz-rules-for-developers пишет:
Не используйте более 4 аргументов, элементы структуры тоже считаются.
Для 1С можно написать 5, но прятать аргументы в структуру не лучшая рекомендация.
There was a problem hiding this comment.
Начиная с 5 параметров глаз уже "начинает теряться" среди такого количества. Почему же прятать аргументы в структуру не лучшая рекомендация?
There was a problem hiding this comment.
Дело в том что в среднем по больнице если у метода большое количество аргументов значит у него с большой вероятностью более одной обязанности (single responsibility principle). И это правило как раз помогает лучше структурировать код на методы, которые делают одну вещь.
There was a problem hiding this comment.
Убедительно. Тут по всей видимости у каждого разработчика своя величина, +- 1
| КонецПроцедуры | ||
| ``` | ||
|
|
||
| - Обязательная аннотация методов. Полноценный комментарий к методу, придерживаясь общих правил комментирования |
There was a problem hiding this comment.
Стивен Макконел в книге "Совершенный код" пишет - если ваш код требует комментариев - перепишите его, чтобы не требовал. В случае если это недостижимо ... (далее идет целая глава)
Поэтому я бы не упоминал обязательную аннотацию методов.
There was a problem hiding this comment.
В таком случае следует написать "Аннотация не требуется, см. наименование метода"
There was a problem hiding this comment.
А есть ли ценность в этой аннотации?
There was a problem hiding this comment.
Соглашусь, ценности в этом случаем ноль получается
| РезультатЗапроса = Запрос.Выполнить(); | ||
| ТаблицаРезультатаЗапроса = РезультатЗапроса.Выгрузить(); |
There was a problem hiding this comment.
Для данного примера я бы не выносил РезультатЗапроса в отдельную переменную.
There was a problem hiding this comment.
Возможно пример получился не самый удачный (можно заменить). Главное сама суть такого подхода
|
По крайней мере я старался, исходя из своего опыта =) |
Не используйте в методе больше трех основных параметров
Не используйте однострочные конструкции со сложной логикой
Обязательная аннотация методов