Visual Studio Code 中 python 的描述性自动完成注释

Question

在 VSCode for C++ 中，输入

/**

然后“输入”，它将生成一个“智能”注释块，具体取决于它是文件头还是函数描述符。在下面的代码块中，这些是默认的（或者我认为是默认的，我可能几年前安装了一个扩展来执行此操作。如果是这样的话，我仍然没有找到一种方法来获得支持python) 注释会阻止它在

/**

然后“输入”之后生成。如果它位于文件顶部，它会生成第一个块，其中包含文件名、作者等。如果它位于函数上方，它会生成 @brief，但还会为每个输入变量动态提供 @param 描述符和 @也回来吧。

/**
 * @file test.cpp
 * @author your name ([email protected])
 * @brief 
 * @version 0.1
 * @date 2024-03-05
 * 
 * @copyright Copyright (c) 2024
 * 
 */


/**
 * @brief 
 * 
 * @param j 
 * @param k 
 * @return char 
 */

char test(int j, int k)
{
    char c = j+k;
    return c;
}

我的问题是Python是否存在这样的方法？

我找到了一种通过使用此链接修改用户片段的“Code/User/snippets/python.json”文件中的 python.json 来创建自定义注释片段的方法。这允许我输入“标题”，它会自动完成以下内容：

'''
@File    :   main.py
@Time    :   03/05/2024 21:27:11
@Author  :   Author
@Version :   1.0
@Contact :   [email protected]
@License :   (C)Copyright 2024, Author
@Desc    :   None
'''

我觉得也有一种方法可以修改这个功能。我知道我可以为函数创建一个单独的用户片段，但是，我还没有弄清楚如何让它为每个输入参数动态生成一个单独的 @brief 行。如果有人知道有什么方法可以让它发挥作用，我们将不胜感激。谢谢！

** 编辑 1：添加这些标题（我忘记提及）的部分目标是将鼠标悬停在函数实例上时显示的函数描述。下面显示了 C++ 文件中的函数。

Answer 1

看看这个扩展：autoDocstring。它的工作原理与所描述的方式完全一样。不过，在使用之前，请根据您的需要进行配置。