Расширение "Процедуры и функции" (документация)

[DenVortEP]

Репозиторий в котором разрабатывается расширение https://github.com/DenVortEP/MethodSearch

В расширении реализована подсистема которая позволяет:

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

[ViktorErmakov]

Было бы замечательно, хотя бы в репозитории продукта, описать примеры использования функционала, для чего он нужен, осветить кейсы. Я пока не понял для чего это нужно. Спасибо!

[DenVortEP]

Идея доработки возникла в результате сотого вопроса коллеги по работе: "А как называется та функция, которая позволяет..?". В организациях с ограниченным ресурсом времени на создание нормальной документации к разработанным решением часто не хватает, разработчики меняются быстро. В результате возникают конфигурации огромного объема. Чтобы найти тот или иной метод с нужным функционалом, требуется много времени (возможно я не знаю быстрых способов). Как вариант, проще иногда разработать новый метод, чем найти тот старый. Если у меня возникал такой вопрос, то приходилось лезть в глобальный поиск и искать тематические фразы. Или вспоминать более общие методы, где использовались нужные. Доработка позволяет уже найденную таким образом функцию отметить некоторой категорией, произвольной. Например "Строковая функция". При последующем поиске по фразе "Строк" она появится в списке найденных методов. Так же поиск можно осуществлять по нескольким кускам фраз в названиях методов или категориях. Последовательность фраз не важна. Например: "Получить ТЗ" или "Таблиц выгруз". Вторая возможность родилась уже при работе с методами и попыткой структурирования и описания того, что есть. При описании методов в комментариях, хотелось соответствовать рекомендациям 1С. Редактировать вручную комментарий к методу, который возвращает структуру с большим количеством элементов, особенно если они тоже структурные, сложно. Попытался упростить этот момент. В доработке есть возможность внести необходимые параметры, описания и получить комментарий в соответствии с рекомендациями 1С. Сейчас после внедрения, обе возможности расширения активно используются. Так же как результат работы - были выявлены методы, дублирующие функционал. На счет кейсов, правильно ли я понял, что мне в описании этого расширения надо добавить примеры использования с последовательными шагами действий в этой же заявке под кратким описанием?

[ViktorErmakov]

Да просто в репозитарии своем сделайте описание в readme. Инструкция с картинками, можно видео записать с кейсами выложить там же ссылку.

[DenVortEP]

Виктор, добрый день. Я добавил расширение в репозиторий (https://github.com/DenVortEP/MethodSearch) Попытался сделать то, о чем Вы просили. Добавил в релизы последнюю версию расширения. Сообщите, пожалуйста, если что-то сделал не так. Это мой первый опыт публичной доработки и работы с GitHub.

[ViktorErmakov]

Да, вполне, спасибо)