Автоформатирование кода
Администрирование - Сервисные утилиты
И как лениво порой бывает, возвращаться к уже рабочему коду, что бы отформатировать его и привести в порядок.
Данная обработка позволяет автоматически форматировать текст кода, в соответствии с настройками пользователя.
Это позволит привести ваш код, как уже написанный так и будущий к единому оформлению.
Что это?
Это внешняя обработка, написанная на управляемых формах (то есть работает только под 8.2).
Как с этим работать?
Работа предполагается в режиме тонкого или толстого клиента. Копируется блок кода (можно кусочком, можно модуль целиком) и помещается в левую часть экрана, нажимается волшебная кнопка и вправой части - появляется отформатированный код.
После чего его можно скопипастить в текст модуля.
А что она может:
- Все строчки а-ля Переменная=4; Переменна2=5; будут оформленны в две строки;
- Все двойные пробелы " " будут заменены на один " ";
- Все двойные пустые строчки будут заменены на одинарные;
- Все что есть в списке "Регулярных выражений" будет приведено к одному регистру;
- Будут настроены отступы, в соотвествии с установленными правилами;
- Количество пробелов перед и после арифметических действий станет одинаковым, в соответствии с настройками пользователя (+,-,*,/,=);
- Можно будет выровнять знаки равенства при последовательной установке значений (если между ними нет пустых строк);
- Можно настроить перед какими выражениями и после каких выражений обязательно нужна пустая строка;
- Можно настроить между какими выражениями не должно быть пустой строки;
- Система автоматически способна определить необходимость комментария к процедуре или функции и вставить шаблон комментария. Пропишет передаваемые параметры.
А как быть с комментариями и переменными?
Все что есть в комментариях и в переменных останется неизменным!
Что за пользовательские настройки и где их брать?
Система имеет настройку "По умолчанию" Хранит в макетах и можно будет начать работать с обработкой сразу.
Так же можно сохранять настройки как в стандартном хранилище настроек (возможности платформы), так и выгружать и загружать настройк в/из файла с расширением *.xml
Причины купить
Когда необходимо покупать?
1. Когда открываете свой код через полгода и долго разбираетесь что тут и как.
2. Когда одну конфигурацию разарабатывает несколько человек, и просто "бесят" привычки некоторых. Например ставить пробел после "=" или не выравнивать знаки равенства :)
3. Когда готовим решение к тиражированию и нужно однообразное оформление кода.
4. Когда есть тяга к прекрасному и красивому (оформлению), но так лениво эту тягу воплощать в жизнь.
Достоинства
Приводит к одному виду программный код разных авторов.
Позволяет не заморачиваться оформлением кода во время написания (полета мысли)
Сравнение версий
Версия 1.0
Скачать файлы
| Наименование | Файл | Версия | Размер | |||
|---|---|---|---|---|---|---|
|
ФорматированиеТекста.epf
.epf 66,91Kb
10.01.13
175
|
.epf | 66,91Kb | 175 | Скачать |
См. также
Специальные предложения
Пока поддерживается только копипаст. В следующей версии предполагается выгрузка текстов модулей из режима предприятия и/или выбор уже выгруженных в файлы и их форматирование с сохранением в текстовые файлы.
Также предполагается запустить орфографическую проверку на наименование метаданных и переменных в модулях. Естественно с учетом правил именования объектов состоящих из нескольких слов.
Конечно не все там есть из перечисленного но можно и добавить.
p.s: в принципе, эту обработку думаю можно портировать для работы прямо из снегопата.
Сам пользуюсь СНЕГОПАТОМ. Вещь с правильной пометкой "must have"!
Можно попробовать реализовать функционал и на скриптах, но стоит ли игра свеч, если учесть, что для всех фломастеры на вкус разные и надо учесть возможность настройки форматирования.
...
Если есть желание, могу предложить такой вариант:
Пишется скрипт для СНЕГОПАТА (сам пока не разбирался с написанием), который по хоткею, копирует выделенный фрагмент текста или весь модуль целиком и помещает его в текстовый файл.
Параллельно запущена моя обработка, которая определяет наличие этого файла, обрабатывает его и кладет новый файл с форматированным кодом рядом. Скрипту СНЕГОПАТА останется только получить текст из нового файла и заменить его на старый.
...
Автору такого скрипта с такой логикой или более удачной - в подарок эта обработка.
...
В будущем предполагается развитие данной обработки и наращивание функционала.
В целом это должно вылиться в небольшую конфигурацию, которая будет контролировать корректность написания кода по оформлению, орфографии, повторяемости процедур и функций, наличие циклов в циклах, запросов в циклах и тому подобное.
Процедура МакросАнализЦикломатическойСложностиТекущегоМодуля() Экспорт
ТекстовоеОкно = Конфигуратор.snegopat.activeTextWindow();
Если ТекстовоеОкно = Неопределено Тогда
глВывестиСообщение("Не найдено текстовое окно!");
Возврат;
КонецЕсли;
ИсходныйКод = ТекстовоеОкно.text;
ТекстМодуля = ИсходныйКод;
Форма = ПолучитьФорму("Форма");
ВычислитьСложностьТекстаМодуля();
Форма.ЭлементыФормы.Панель1.ТекущаяСтраница = Форма.ЭлементыФормы.Панель1.Страницы.СтраницаРезультаты;
Форма.ОткрытьМодально();
КонецПроцедуры
ПоказатьТак, что если у вас весь разбор делается в модуле и сильно не завязано на управляемые формы, то можно легко и просто добавить вызов данной обработки прям из конфигуратора.
Посмотрите на скрипт spellchecker.js , там тоже есть проверка как word так и libreoffice.
Интересно. Спасибо.
Все форматирование происходит в модуле объекта. на формах реализованы только выбор настроек и вывод результата.
Еще бы придумать как настройки легко менять и будет вообще все в ажуре.
В принципе если заодно передать настройки в строке в формате XML можно для основного форматирования вообще обойтись без интерфейса.
А обработку использовать для создания настроек :)
Готовы взяться за сопряжение со СНЕГОПАТОМ?
Если обработка не полезна, то ей нет места ни в платном разделе, ни в бесплатном.
...
Посмотрим как это получится объединить со СНЕГОПАТОМ.
...
Возможно эта обработка через некоторое время станет продуктом лайт (то есть демкой, то бишь бесплатной).
А платной станет конфигурация, с большим функционалом.
Вопрос только сколько будет стоить эта конфигурация :)
Поэтому есть смысл купить обработку сейчас, что бы потом не платить больше.
Равно как и есть смысл подождать, когда обработка станет бесплатной.
Решение за вами!
Идея этой обработки заключается в том, что не надо переучиваться под единый стандарт, если привести к общему знаменателю можно набором достаточно нехитрых алгоритмов.
а тем кто пишет как попало, вообще головы поотрывал бы... когда читаешь их код, думаешь, что они курили... я не в плане алгоритма, а в плане оформления, что бы удобно было читать... но за работу плюс
Именно из-за этого данная работа и была проделана.
1. Когда видишь такой код - спокойно его форматируешь, и читаешь уже более привычном формате.
2. Когда одну конфу пишут несколько человек, что бы не заставлять и не переучивать людей к единообразному оформлению. перед сдачей прогоняешь через обработку и получаешь единообразный код.
если с этой точки зрения, когда пишут несколько человек, согласен, нужная вещь... вот интересно, а форматирует код под один шаблон, или можно под себя настраивать? а то не очень хорошо получается, пишут несколько человек, а код форматируется под одного человека ;)
Мы у себя в отделе за основу приняли стандарты оформления изложенные на диске ИТС + оптимизировали под себя.
Форматироваться код должен не под одного человека, а с точки зрения правил принятых между разработчиками -участниками.
Еще раз хочу акцентировать внимание, лучше уж отформаированный говнокод, чем неотформатированный.
1. 0 (пробел) 0 (кол-во пробелов до и после)
Пример:
Возврат (пробелы) СтруктураДействий; -> Возврат СтруктураДействий;
2.Расшифровка представления
Пример:
// ДанныеПараметры - ТИПДАННЫХ - ОПИСАНИЕ -> // ДанныеПараметры - ТИПДАННЫХ - Данные параметры
От двойных пробелов убирает.
Возврат СтруктураДействий; -> Возврат СтруктураДействий;
..
Описание добавляет, если его нет, если описание есть - то оставляет его нетронутым
// ДанныеПараметры - ТИПДАННЫХ -> // ДанныеПараметры - ТИПДАННЫХ - ОПИСАНИЕ
, но если
// ДанныеПараметры - ТИПДАННЫХ - Параметр вывода ТЗ -> // ДанныеПараметры - ТИПДАННЫХ - Параметр вывода ТЗ
У меня практически всегда когда что-то пишу рядом открыт и пользовательский режим. Не проблема CTRL-C CTRL-V пару раз жамкнуть. А учитывая возможность настройки под себя - да вообще вполне самостоятельная вещь.
Пример:
НСтр("ru = 'Накладная на перемещение';uk = 'Накладна на переміщення'", КодЯзыкаПечать)НСтр("ru = 'Накладная на перемещение';
uk = 'Накладна на переміщення'", КодЯзыкаПечать)
Ошибки и недочеты безусловно есть, но как часто бывает, нет времени их устранить, тем более, что после написания обработки стал писать код сразу правильно :))
Если у кого есть желание дописать обработку - welcome! Могу опубликовать обновленную версию у себя, можете выложить ее в своем блоге - ссылку на обновление здесь размещу.
Просмотры 34479
Загрузки 39
Комментарии 57
Создание 19.12.12 17:02
Обновление 10.01.13 16:33
№ Публикации 166814
Рубрики
Сервисные утилиты,
ОБРАБОТКИ,
Чистка базы,
Справки,
Оптимизация БД (HighLoad),
Инструментарий,
Практика программирования,
Универсальные обработки,
Сертификация,
Теория программирования,
Системное ПРОГРАММИРОВАНИЕ,
Тестирование и исправление,
Стартеры 1С
Кому Программист
Тип файла Внешняя обработка (ert,epf)
Платформа Платформа 1С v8.x (все механизмы)
Конфигурация
Конфигурации 1cv8 ,
Не имеет значения
Операционная система Windows
Страна Не имеет значения
Отрасль Не имеет значения
Налоги Не имеет значения
Вид учета Не имеет значения
Раздел учета Не имеет значения
Доступ к файлу Абонемент ($m)
Код открыт Не указано
