Про самодокументируемость кода:

, ,

гуру

14.10.16

✎

11:39

1. Другой вариант (какой?)	55% (6)
2. Второй вариант	27% (3)
3. Первый вариант	18% (2)

Всего мнений: 11

Что лучше:

Вариант 1:

Процедура ПередЗаписью()
....
  // тут может быть комментарий про необходимость, если условие не самодокументируемое (типа статус = НужныйСтатус)
  Если НеобходимоЧтоТоСделать() Тогда
    ЧтотоСделать();
  КонецЕсли;
....
КонецПроцедуры

Вариант 2:

Процедура ПередЗаписью()
....
  // тут может быть комментарий про необходимость, и он должен быть всегда
  ЧтотоСделатьПриНеобходимости();
....
КонецПроцедуры

Процедура ЧтотоСделатьПриНеобходимости()
  Если Не НеобходимоЧтоТоСделать() Тогда
    Возврат;
  КонецЕсли;
....
КонецПроцедуры

2 Gary417

14.10.16

✎

11:43

(1) Этим надо дополнить второй вариант

Второй вариант

16 mistеr

14.10.16

✎

11:49

(0) Условие может быть не простое, условий может быть несколько. Вызов может использоваться в куче объектов, не копипастить же везде лишний код.

Комментарий про необходимость достаточно поместить в ЧтотоСделатьПриНеобходимости().

Второй вариант

38 Stepa86

26.10.16

✎

11:10

Достаточно одинаковые варианты. Если отталкиваться только от того, что описано в (0), то второй вариант мне больше нравится. В реальности буду смотреть на повторное использование, понятность, размещение, методы по соседству, объем кода, необходимость отладки итп.
Сами 1С в УП/УТ11 в модулях документов в обработке проведения делают больше по второму варианту, а в остальных по первому

Второй вариант