Skip to content

Documentation

AziatkaVictor edited this page Feb 25, 2023 · 1 revision

Первое, что необходимо сделать - вызвать команду Add Documentation через нажатие сочетания клавиш Ctrl+Shift+P и выбрав в списке нужный пункт:

Step1

Далее выбираем файл с нужной нам функцией, для которой хотим написать документацию (при вызове автодополнение сбоку пишется, из какого файла взята функция):

Step2

Далее выбираем саму функцию, список генерируется таким же образом, как бы обычно работало автодополнение. То есть, при наличии пользовательских функций, они появятся в списке:

Step3

Если расширение нашло у пользователя документацию этой функции, то оно уточнит, стоит ли перезаписывать информацию (работает только с пользовательской документацией, информацию самого расширения оно игнорирует):

Question

После всего, появиться поле ввода текста. У расширения есть поддержка Markdown так что можно оформить описание так, как захочется.

Step4

В конце окно закроется, появится уведомление об успешном добавлении документации и расширение начнет отображать то, что было введено ранее:

Result

Вся документация будет храниться в настройках Workspace открытого проекта. Если есть желание помочь в заполнении оригинальной документации, то прошу обратиться ко мне, AziatkaVictor, и передать это любым удобным образом.