Документирование — это описание назначения функции или операции, ее параметров и результата работы. Документирование упрощает доработку кода и снижает риск ошибок.
- Откройте функцию или операцию в режиме редактирования.
- Нажмите .
- Заполните свойства, укажите возвращаемый объект, добавьте аргументы.
- Сохраните изменения.
Описание отобразится в редакторе прикладного кода:
- в подсказках и при наведении — показывается назначение функции;
- в автодополнении — имя, тип и описание;
- в списке функций — краткая информация о функции.
Нашли неточность? Выделите текст с ошибкой и нажмите ctrl + enter.