акционерное общество «фрейт линк
advertisement
АКЦИОНЕРНОЕ ОБЩЕСТВО
«ФРЕЙТ ЛИНК»
Страница 1 из 9
Регламент внесения изменений в конфигурации продуктов на
платформе 1С версии 8.Х
Данный регламент описывает обязательный ряд действий для программистов, ведущих
разработку нового или доработку существующего функционала конфигураций 1С предприятия в
АО «Фрейт Линк».
1. Создание нового объекта конфигурации
1.1. При создании в конфигурации нового объекта, его имя должно содержать префикс «фл».
Префикс должен быть написан маленькими буквами, в то время как имя объекта, идущее
непосредственно за префиксом, должно начинаться с заглавной буквы. Например:
флРассылкиЭлектронныхСообщений, флНастройкаПараметров. Имена реквизитов и
табличных частей таких объектов в префиксе не нуждаются, однако они должны носить
информативный характер.
1.2. Созданный объект конфигурации (кроме подсистем) должен быть включен в подсистему,
в которой ведутся разработки. Подсистема так же должна иметь префикс «фл». Если
объект невозможно отнести к какой-либо подсистеме, он должен быть включен в
подсистему «флПрочиеМодификации». В случае отсутствия такой подсистемы в
конфигурации, ее необходимо добавить.
1.3. Для внешних подрядчиков, созданный объект должен быть дополнительно включен в
подсистему фл<ОрганизацияПодрядчика>. Если такой подсистемы нет, то ее
необходимо создать с префиксом «фл».
2. Изменение существующих объектов конфигурации
2.1. При создании реквизитов, табличных частей, форм, макетов и прочих свойств объекта
конфигурации, созданного разработчиками фирмы 1С – имя создаваемого элемента
должно содержать префикс «фл».
2.2. При изменении реквизитов объекта конфигурации, созданного разработчиками фирмы
1С, необходимо написать соответствующий комментарий к реквизиту. Например:
2.3. Измененные объекты стандартной конфигурации прикладного решения 1С должны быть
подчинены подсистеме флИзменныеОбъектыСтандартнойКонфигурации. В случае
отсутствия такой подсистемы в конфигурации, ее необходимо добавить.
АКЦИОНЕРНОЕ ОБЩЕСТВО
«ФРЕЙТ ЛИНК»
Регламент внесения изменений в конфигурации продуктов на платформе 1С
Страница 2 из 9
2.4. Если предполагается создание дополнительной процедуры (функции) и вызов ее в модуле
формы или в модуле объекта, созданного разработчиками фирмы 1С – процедура
(функция) должна располагаться в общих модулях. Общие модули при этом, должны
иметь префикс «фл».
Изменения, вносимые в объекты, созданные разработчиками фирмы 1С должны
быть минимальны.
2.5. Создание элементов на форме объекта, созданного разработчиками фирмы 1С,
преимущественно должно выполняться с помощью программного кода. Имя создаваемого
элемента формы должно содержать префикс «фл».
2.6. При добавлении и/или изменении кода в существующих объектах, его необходимо
обязательно описать в блоке комментария:
2.6.1. При добавлении программного кода без изменения существующего кода,
комментарий должен быть вида:
//-=Н=- по запросу № <Номер запроса> (<Краткое описание изменения ОБЯЗАТЕЛЬНО!>)
//<ФИО разработчика>, < Дата>
//Описание:<При сложных алгоритмах описание должно отражать логическую суть>
<Программный код>
//
//-=К=-
Например:
Для внешних подрядчиков, после ФИО разработчика необходимо указывать
название его организации.
2.6.2. При добавлении программного кода с изменением/заменой уже существующего
кода, комментарий должен быть вида:
//-=Н=- по запросу № <Номер запроса> (<Краткое описание (ОБЯЗАТЕЛЬНО!)>)
// <Разработчик> ,<Дата>
// Описание: <При сложных алгоритмах описание должно отражать логическую суть>
//--------------//-=Старый код=//--------------//<Старый код, который заменяется (закомментированный)>
//--------------//-=Новый код=//--------------<Новый программный код>
//
//-=К=-
АКЦИОНЕРНОЕ ОБЩЕСТВО
«ФРЕЙТ ЛИНК»
Регламент внесения изменений в конфигурации продуктов на платформе 1С
Страница 3 из 9
Например:
2.6.3. При добавлении новой процедуры, ее обязательно нужно описать в следующем
формате:
// Процедура <Краткое описание (ОБЯЗАТЕЛЬНО)>
// Запрос № <Номер запроса>
// Автор: <ФИО разработчика>, <Дата>
// Описание:
//
// Параметры:
//
Процедура <Имя процедуры>()
<Программный код процедуры>
КонецПроцедуры //<Имя процедуры>
Например:
2.6.4. При добавлении новой функции, ее обязательно нужно описать в следующем
формате:
// Функция <Краткое описание (ОБЯЗАТЕЛЬНО)>
// Запрос № <Номер запроса>
// Автор: < ФИО разработчика>, <Дата>
// Описание:
//
// Параметры:
//
// Возвращаемое значение:
//
Функция <Имя функции>()
<Программный код функции>
КонецФункции //<Имя функции>
АКЦИОНЕРНОЕ ОБЩЕСТВО
«ФРЕЙТ ЛИНК»
Регламент внесения изменений в конфигурации продуктов на платформе 1С
Страница 4 из 9
Например:
С целью облегчения комментирования кода, в приложении 2 прилагается текст файла-шаблона
комментариев. Инструкция по подключению шаблона указана в приложении 1.
АКЦИОНЕРНОЕ ОБЩЕСТВО
«ФРЕЙТ ЛИНК»
Регламент внесения изменений в конфигурации продуктов на платформе 1С
Страница 5 из 9
Приложение 1.
Инструкция по подключению шаблона комментариев.
Для настройки комментариев необходимо:
1. Текст шаблона (Приложение 2) сохранить на диске в текстовом файле с расширением
«*.st».
2. В конфигураторе включить автозамену. Для этого открываем параметры через
соответствующие пункты меню Сервис -> Параметры, и на странице «Модули»
открывшегося диалогового окна выбираем в поле автозамена «Включить с подсказкой» и
выставляем флаг «Использовать автозамену в комментариях»:
Для подключения файла шаблонов, в пункте меню Сервис выбираем пункт Шаблоны текста
В открывшемся окне шаблонов текста переходим в настройки шаблона
АКЦИОНЕРНОЕ ОБЩЕСТВО
«ФРЕЙТ ЛИНК»
Регламент внесения изменений в конфигурации продуктов на платформе 1С
Страница 6 из 9
И подключаем сохраненный вами файл:
Далее редактируем тексты шаблона под себя, заменяем «Разработчик» на свою фамилию и
организацию, и, при необходимости, меняем строку автозамены:
По умолчанию автозамена будет происходить при написании в модуле текста символов «//-»
АКЦИОНЕРНОЕ ОБЩЕСТВО
«ФРЕЙТ ЛИНК»
Регламент внесения изменений в конфигурации продуктов на платформе 1С
Страница 7 из 9
Приложение 2.
Текст файла шаблона комментариев
{1,
{2,
{"Комментирование кода",1,0,"",""},
{2,
{"Управляющие",1,0,"",""},
{0,
{"Процедура с заголовком",0,0,"Процедура","<?""Место исполнения:"", ВыборВарианта, ""Без директивы"","""",""На сервере"", ""&НаСервере"", ""На клиенте"", ""&НаКлиенте"",
""На Web клиенте"", ""&НаВебКлиенте"", ""На клиенте и сервере"", ""&НаКлиентеНаСервере"", ""На сервере без контекста"", ""&НаСервереБезКонтекста"", ""На клиенте и сервере
без контекста"", ""&НаКлиентеНаСервереБезКонтекста"">
// Процедура <?""Краткое описание (ОБЯЗАТЕЛЬНО)"">
// Запрос № <?""По запросу №"">
// Автор: <?"""", ВыборВарианта, ""Разработчик"", ""Разработчик""> <?"""", ДатаВремя, ""ДФ=dd.MM.yyyy"">
// Описание:
//
// Параметры:
//
Процедура <?""Введите имя процедуры"">()
<?>
КонецПроцедуры //<?""Введите имя процедуры"">
"}
},
{0,
{"Функция с заголовком",0,0,"Функция","<?""Место исполнения:"", ВыборВарианта, ""Без директивы"","""",""На сервере"", ""&НаСервере"", ""На клиенте"", ""&НаКлиенте"", ""На
Web клиенте"", ""&НаВебКлиенте"", ""На клиенте и сервере"", ""&НаКлиентеНаСервере"", ""На сервере без контекста"", ""&НаСервереБезКонтекста"", ""На клиенте и сервере без
контекста"", ""&НаКлиентеНаСервереБезКонтекста"">
// Функция <?""Краткое описание (ОБЯЗАТЕЛЬНО)"">
// Запрос № <?""По запросу №"">
// Автор: <?"""", ВыборВарианта, ""Разработчик"", ""Разработчик""> <?"""", ДатаВремя, ""ДФ=dd.MM.yyyy"">
// Описание:
//
// Параметры:
//
// Возвращаемое значение:
//
Функция <?""Введите имя функции"">()
<?>
КонецФункции //<?""Введите имя функции"">
АКЦИОНЕРНОЕ ОБЩЕСТВО
«ФРЕЙТ ЛИНК»
Регламент внесения изменений в конфигурации продуктов на платформе 1С
"}
}
},
{5,
{"Комментарии",1,0,"",""},
{0,
{"Коммент. БЕЗ ЗАМЕНЫ кода",0,0,"//-","//-=Н=- по запросу № <?""Номер запроса""> (<?""Краткое описание (ОБЯЗАТЕЛЬНО!)"">)
// <?"""", ВыборВарианта, ""Разработчик"", ""Разработчик"">, <?"""", ДатаВремя, ""ДЛФ=DDT"">
// Описание:
<?>
//
//-=К=-"}
},
{0,
{"Коммент. С ЗАМЕНОЙ кода",0,0,"//-","//-=Н=- по запросу № <?""Номер запроса""> (<?""Краткое описание (ОБЯЗАТЕЛЬНО!)"">)
// <?"""", ВыборВарианта, ""Разработчик"", ""Разработчик"">, <?"""", ДатаВремя, ""ДЛФ=DDT"">
// Описание:
//--------------//-=Старый код=//---------------
<?>
//--------------//-=Новый код=//---------------
//
//-=К=-"}
},
{0,
{"Коммент. ЗАПРОС, БЕЗ ЗАМЕНЫ кода",0,0,"//-","|//-=Н=- по запросу № <?""Номер запроса""> (<?""Краткое описание (ОБЯЗАТЕЛЬНО!)"">)
|// <?"""", ВыборВарианта, ""Разработчик"", ""Разработчик"">, <?"""", ДатаВремя, ""ДЛФ=DDT"">
|// Описание:
|<?>
|//
|//-=К=-"}
},
Страница 8 из 9
АКЦИОНЕРНОЕ ОБЩЕСТВО
«ФРЕЙТ ЛИНК»
Регламент внесения изменений в конфигурации продуктов на платформе 1С
{0,
{"Коммент. ЗАПРОС, С ЗАМЕНОЙ кода",0,0,"//-","|//-=Н=- по запросу № <?""Номер запроса""> (<?""Краткое описание (ОБЯЗАТЕЛЬНО!)"">)
|// <?"""", ВыборВарианта, ""Разработчик"", ""Разработчик"">, <?"""", ДатаВремя, ""ДЛФ=DDT"">
|// Описание:
|//---------------
|//-=Старый код=|//---------------
|<?>
|//---------------
|//-=Новый код=|//---------------
|
|//
|//-=К=-"}
},
{0,
{"Описание авторского блока по запросу №",0,0,"///","////////////////////////////////////////////////////////////////////////////////
//-=Н=- по запросу № <?""Номер запроса""> (<?""Краткое описание (ОБЯЗАТЕЛЬНО!)"">)
//
//
Автор:
<?"""", ВыборВарианта, ""Разработчик"", ""Разработчик""> <?"""", ДатаВремя, ""ДЛФ=DDT"">
// Описание: <?>
//
////////////////////////////////////////////////////////////////////////////////
//-=К=- по запросу № <?""Номер запроса"">
////////////////////////////////////////////////////////////////////////////////"}
}
}
}
}
Страница 9 из 9