Для описания в языковых файлах предлагаю
1. Использовать сами идентификаторы описываемых событий, то есть например:
$MESS["OnAfterIBlockSectionAdd"] = "Добавление раздела инфоблока"; |
без добавления дополнительных идентификаторов, типа "mymodul_" и т.д., так как по заданному стандарту предполагается присутствие всех нужных партнерских идентификаторов в имени идентификатора события.
2. Описывать событие в неопределенной форме, кратко, то есть "Добавление раздела инфоблока" можно использовать такое описание в любом месте, а вот "Событие вызываемое при добавлении раздела информационного блока", или "Вызывается при создании раздела", или "Позволяет изменить данные созданного раздела" и т.д. не универсально.
3. Описывать только стабильные события, то есть те, которые можно смело использовать, не боясь, что они будут переименованы, удалены и т.д.
Наличие языковых файлов позволит разработчикам, использующих события:
1. Упростить поиск доступных и стабильных событий.
2. Упростит получение списка событий в человекопонятном виде, а значит уменьшит время на формирование функционала, и исключит не нужны прослойки.
3. Упростит жизнь тем, кто активно работает с событиями, освободив массу времени от задач по постоянному добавлению новых событий, удалению убитых и т.д.
Ну реально наболело и отнимает слишком много времени на актуализацию и очеловечивание списка событий, особенно в части партнерских модулей!
ВАЖНО: ключи в массиве языковых значений должны полностью соответствовать символьному представлению события в коде включая РЕГИСТР, это значительно упростит написание кода, это позволит получать символьное представление событий для динамической вставки в код, равно как позволит получать человекопонятное описание события для последующей динамической вставки и вывода и т.д.