Оформление конфигураций

Как и любой продукт, разрабатываемая конфигурация кроме непосредственно функционального содержания и правильной работы должна обладать определенными свойствами, обеспечивающими ее удобное использование и модифицирование.

При разработке внешнего интерфейса (меню, диалогов форм, табличных документов) не следует пренебрегать тщательным оформлением различных окон конфигурации. Стиль оформления интерфейса также будет иметь значение при оценке пользователями уровня и качества разработанных решений. Стиль разработки самой конфигурации (внутренних составляющих) также достаточно важен при групповой разработке или в случае предполагаемой передачи конфигурации для сопровождения другим специалистам. При разработке тиражных конфигураций (рассчитанных на распространение в качестве готового решения) оформлению и стилю разработки конфигураций должно придаваться особое значение.

Приведем некоторые рекомендаций по внешнему оформлению интерфейса конфигурации и стилю разработки внутренних составляющих.

Объекты метаданных должны иметь осмысленные идентификаторы;

Для объектов метаданных имеющих длинные или сложные (состоящие из нескольких слов) идентификаторы должны задаваться синонимы;

Пункты меню должны быть аккуратно и осмысленно распределены по колонкам;

Элементы диалогов форм должны быть выровнены и удобно размещены;

Для функционально важных элементов диалогов форм должны быть предусмотрены подсказки;

В диалогах форм должен быть установлен порядок обхода элементов диалога, обеспечивающий удобный ввод и навигацию по диалогу;

Рекомендуется все диалоги форм разрабатывать таким образом, чтобы они умещались на экране в режиме 640х4 Это позволит работать с конфигурацией на компьютерах имеющих только такое разрешение (например, маленьких портативных компьютерах), и обеспечит комфортную работу в режиме 800х600, являющимся достаточно распространенным;

Тексты модулей конфигурации должны быть удобочитаемыми и понятными;

Все переменные и вызовы процедур, функций, методов должны быть выполнены на одном языке (русском или английском);

Текст модулей должен быть выровнен "лесенкой" (синтаксический отступ);

В тексте должны присутствовать комментарии для сложных алгоритмов;

В модулях должны использоваться осмысленные имена переменных, процедур и функций отражающие их назначение;

Конфигурация не должна содержать ошибок в текстах модулей приводящих к выдаче системных сообщений пользователю;

Средства 1С:Предприятия должны использоваться штатным образом в соответствии с их назначением;

Не следует использовать функции сохранения значений в строку для хранения значений в информационной базе;

Конфигурация должна иметь описания для всех объектов типа Справочник, Документ, Перечисление, Отчет, Обработка, Журнал, Регистр, План счетов, Журнал Расчетов, Календарь, Группа расчетов, а также для всей конфигурации в целом;

В конфигурации должен быть отключен режим непосредственного удаления. Средствами языка не должно выполняться непосредственное удаление объектов тех видов, на которые могут иметься ссылки в ИБ;

Конфигурация должна быть "сдержанной" с точки зрения использования возможностей цветового оформления диалогов, отчетов, а также включения картинок;

Не рекомендуется в диалогах и табличных документах использовать шрифты (наименования шрифтов) отличные от  стандартных, так как на компьютерах пользователей они могут быть не установлены;

Не рекомендуется при использовании внешних файлов применять длинные и русскоязычные имена (это в некоторых случаях может привести к ошибкам связанным с работой операционных систем или других программ, например, независимых программ резервного копирования);

Константы языка типа "Дата" и строковые значения, преобразуемые к типу "Дата", должны задаваться с четырьмя цифрами года;

При использовании внешних файлов следует применять только относительные пути, для обеспечения переносимости информационной базы;