среда, 22 июня 2016 г.

1С Шаблон кода: Стандарты оформления модулей

Согласно системе стандартов и методик разработки конфигураций фирмы 1С модуль должен быть оформлен согласно рекомендациям. Помимо удобства при разработке и сопровождении кода это будет особенно необходимо для получения 1С:Совместимо для вашего программного продукта.


При оформлении кода следует придерживаться пунктов, перечисленных в системе стандартов на сайте ИТС. С платформы версии 8.3 разделы оформляются в виде областей. Для соблюдения стандартов можно использовать шаблоны кода:
  • Описание переменной. Автозамена: Перем

  • Перем <?"Введите имя переменной">; // <?"Введите описание переменной">

  • Общий модуль. Автозамена: ОбщийМ[одуль]:

  • ////////////////////////////////////////////////////////////////////////////////
    // <Заголовок модуля: краткое описание и условия применения модуля.>
    //  
    ////////////////////////////////////////////////////////////////////////////////
    
    #Область ПрограммныйИнтерфейс
    
    #КонецОбласти
    
    
    #Область СлужебныеПроцедурыИФункции
    
    #КонецОбласти

  • Модуль формы. Автозамена: МодульФ[ормы]

  • 
    #Область ОбработчикиСобытийФормы
    
    #КонецОбласти
    
    
    #Область ОбработчикиСобытийЭлементовШапкиФормы
    
    #КонецОбласти
    
    
    #Область ОбработчикиСобытийЭлементовТаблицыФормы<ИмяТаблицыФормы>
    
    #КонецОбласти
    
    
    #Область ОбработчикиКомандФормы
    
    #КонецОбласти
    
    
    #Область СлужебныеПроцедурыИФункции
    
    #КонецОбласти

  • Модуль объекта, менеджера, набора записей, обработки, отчета... Автозамена: МодульО[бъекта]

  • 
    #Область ПрограммныйИнтерфейс
    
    #КонецОбласти
    
    
    #Область ОбработчикиСобытий
    
    #КонецОбласти
    
    
    #Область СлужебныеПроцедурыИФункции
    
    #КонецОбласти
В любом модуле могут быть следующие разделы:
  • заголовок модуля - описание модула, для модуля форм содержит описание параметров формы;
  • раздел описания переменных - с комментариями для их пинимания;
  • программный интерфейс - используемые другими объектами (если используется самими объектом, то помещаем в служебные)
  • обработчики событий объекта (формы)
  • служебные процедуры и функции модуля - внутренняя реализация модуля, могут быть экспортными если используются этим же объектом, если являются частью функциональной подсистемы и вызываются другими объектами этой подсистемы;
  • раздел инициализации