mirror of
https://github.com/1C-Company/v8-code-style.git
synced 2025-04-03 18:15:26 +02:00
29 lines
2.5 KiB
Markdown
29 lines
2.5 KiB
Markdown
# Панель "Bsl Документирующий комментарий"
|
|
|
|
Контекстная панель показывает структуру документирующего комментария в иерархическом виде при выборе метода.
|
|
|
|
Панель позволяет выделять элемент модели и текст в редакторе.
|
|
|
|
## Открыть панель
|
|
|
|
Эта панель входит в стандартный состав перспективы 1С:Enterprise. Если вы закрыли эту панель или находитесь в другой перспективе, вы можете открыть эту панель из главного меню основного окна, нажав `Окно > Показать панель > Прочие… > 1С:Стандарты разработки V8 > Bsl Документирующий комментарий`.
|
|
|
|
### Проблема
|
|
|
|
Примеры проблемных ситуаций в языке документирующего комментария:
|
|
|
|
- Описание параметров - забывают поставить двоеточие после ключевого слова
|
|
- Описание полей структур, таблиц значений - забывают ставить звездочки, тире, двоеточие
|
|
- Описание списка типов с пояснениями типов - пишутся неправильно (запятые, тире и так далее)
|
|
- Описываются значения полей через звездочку как новое подчиненное поле - что в корне не верно.
|
|
- Многострочные комментарии при описании параметра с типом, содержащим расширение полей (что не поддерживается форматом)
|
|
- и др. ошибки.
|
|
|
|
|
|
Структурированные данные документирующего комментария позволяют разработчику видеть тот объект, который разбирает 1C:EDT.
|
|
|
|
## Дополнительно
|
|
|
|
- Стандарт [Описание процедур и функций](https://its.1c.ru/db/v8std#content:453:hdoc)
|
|
- Документация 1C:EDT [Комментирование процедур и функций](https://its.1c.ru/db/edtdoc#content:330:hdoc)
|