Продолжая тему (http://www.community.terrasoft.ru/blogs/7301), поднятую мной же, выкладываю как скрипт, формирующий документ с описанием функций, так и сам документ.
На данный момент описан пока только скрипт scr_DB (в планах описать, хотя бы частично, scr_WindowUtils). По остальным, наиболее используемым скриптам, надеюсь, мне помогут все желающие. :)
Правила формирования описаний функций:
1. Описываемые скрипты прописываются в параметре ScriptsArray (в самом верху скрипта scr_ConfigurationFunctionsDocument). На данный момент, как я писал выше, там прописан только scr_DB.
2. Для формирования комментариев к функциям следует придерживаться следующего формата:
Входящие параметры:
Param1 - описание параметра;
Param2 - описание параметра
*/
function MyFunction(Param1, Param2) {
...
}
Сам скрипт scr_ConfigurationFunctionsDocument пробегается по всему содержимому и "выдергивает" комментарии перед функциями, обрамленные "/*" и "*/".
Примечание: Прикрепляю scr_DB с комментариями, предназначенный для того, кто хочет сформировать такой документ на своей конфигурации. С этим связано и предупреждение. Если в scr_DB Вами добавлялись какие-то функции, то тогда Вам нужно будет слить Ваш текущий вариант этого сервиса и тот, что я прикрепил. Будьте, пожалуйста, внимательны, поскольку скрипт scr_DB используется везде, во всей системе, и потеря в сервисе одной функции может привести к некорректной работе всей системы. Просьба делать бекап перед такими экспериментами.
Интересно, как повлияет на быстродействие системы добавление строчек с описанием функций в общеиспользованные скрипты? Насколько это способно затормозить систему? Не раз сталкивался с тем фактом, что большие скрипты или большое количество подключаемых скриптов замедляют работу системы.
Еще одна интересная мысль для проверки: при загрузке текста скриптов в оперативную память загружаются ли комментарии или они игнорируются? То есть, влияет ли количество комментариев в скрипте на объем используемой памяти при его загрузке?