Python中如何在vscode上使用Doxygen自动生成注释

网上查了一下貌似 Doxygen 还不错还可以导出到文档。 在 vscode 上安装了 Doxygen Documentation Generator 插件, 但是装完后,只能给 C 语言文件自动生成。 是我用法不对,还是就是不支持 python ?


Python中如何在vscode上使用Doxygen自动生成注释
2 回复

在VSCode中使用Doxygen自动生成注释,可以安装Doxygen插件并配置快捷键。以下是具体步骤:

  1. 安装插件:在VSCode扩展商店搜索"Doxygen Documentation Generator"并安装。

  2. 基本使用:在函数或类上方输入/**并按回车,插件会自动生成Doxygen格式的注释模板。

  3. 自定义配置:在VSCode设置中搜索"Doxygen",可以修改注释模板的格式,比如使用@param还是\param

  4. 快捷键:默认快捷键是Ctrl+Alt+D(Windows)或Cmd+Alt+D(Mac),可以在键盘快捷键设置中修改。

这里有个简单的例子,安装插件后,在函数上面输入/**然后回车:

/**
 * @brief 计算两个数的和
 * @param a 第一个加数
 * @param b 第二个加数
 * @return 两个数的和
 */
def add(a, b):
    return a + b

插件会自动填充这些标签,你只需要填写具体的描述内容。

总结:装个Doxygen插件就能自动生成注释模板了。


doxygen 本身是支持 Python 的 格式参考如下链接
http://www.doxygen.org/manual/docblocks.html#pythonblocks

但我没用过你说的插件

回到顶部