VSCode快捷键为函数添加注释
·
基于autoDocstring插件的函数注释
安装autoDocstring插件
安装操作直接参考[1]。在官方可选的模板中,可以找到sphinx-notypes和google等多种注释模板

其中,sphinx-notypes的效果如下(在光标处使用快捷键,为Ctrl+Shift+2):

目标:修改模板文件,删除其中的"_sumary_“和”_description_",如下:

自定义注释模板
-
新建自定义模板
使用everything找到sphinx-notypes文件的路径,使用vscode打开:
新建**.mustache文件,以sphinx-notypes.mustache文件为基础修改如下:{{! Sphinx Docstring Template without Types for Args, Returns or Yields }} {{#args}} param {{var}}: {{/args}} {{! 关键字模板}} {{#kwargs}} param {{var}}: {{descriptionPlaceholder}}, defaults to {{&default}} {{/kwargs}} {{#exceptions}} raises {{type}}: {{descriptionPlaceholder}} {{/exceptions}} {{#returns}} return: {{/returns}} {{#yields}} yield: {{descriptionPlaceholder}} {{/yields}} -
设置自定义mustache路径
在Custom Template Paht中设置路径(注意Debug的路径信息):
../../../../mnt/c/Users/27395/.vscode/extensions/njpwerner.autodocstring-0.6.1/out/docstring/templates/lcx.mustache
若output中提示路径报错,则按照报错信息逐步修改路径:

参考
更多推荐

所有评论(0)