Блог

Главная - Вопросы по программированию - Как использовать фрагменты кода в vscode для определения комментариев входных параметров функции python (имя и тип параметра)?

Как использовать фрагменты кода в vscode для определения комментариев входных параметров функции python (имя и тип параметра)?

#visual-studio-code #code-snippets

Вопрос:

Например, когда я набираю «»» под подписью функции python, это запускает автоматический анализ комментариев параметров функции, которые содержат информацию об определении, типе, значении по умолчанию и т. Д. Входных и выходных параметров функции. Я не хочу использовать сторонний плагин для этого, я хочу использовать собственные фрагменты vscode для этого.

 def myfun(a,b,c=1,d="defaultvalue"):
"""


Parameters
----------
a : TYPE
    DESCRIPTION.
b : TYPE
    DESCRIPTION.
c : TYPE, optional
    DESCRIPTION. The default is 1.
d : TYPE, optional
    DESCRIPTION. The default is "defaultvalue".

Returns
-------
str
    DESCRIPTION.

"""
return "test"

введите описание изображения здесь

Комментарии:

1. фрагменты не имеют доступа к содержимому предыдущей строки(строк), без расширения, у которого есть поставщик завершения, вы не заставите его работать, где вы получаете TYPE переменную, в примере ничего не определено, функция примера возвращает что-то, поэтому она также должна проанализировать всю функцию, чтобы найти результат

2. взгляните на расширение Hypersnips , набрав def name(a,b): «ввод» фрагмента после его запуска с префиксом, посмотрите на пример поля на странице расширения

3. В приведенном выше примере IDE spyder автоматически генерирует комментарии к функциям, если не использовать расширения, vscode(фрагменты) может автоматически генерировать их, было бы неплохо.

4. Я знаю, что это не использует vscode(фрагменты), но я наткнулся на расширение генератора строк документов Python , которое делает именно то, что вы хотите.

Метки: