推荐俩款Python插件

生成好看注释的插件,后面我专门写源码解读和具体使用的方法

快速的生成函数注释

光标必须在定义正下方的行上，以生成完整的自动填充的文档字符串

• 用三引号（"""或'''）打开文档字符串后按Enter
• 键盘快捷键：ctrl+shift+2或cmd+shift+2Mac
  • 可以在首选项->键盘快捷键-> extension.generateDocstring中更改
• 命令： Generate Docstring
• 右键菜单： Generate Docstring

https://github.com/NilsJPWerner/autoDocstring

这个是两个插件的具体使用样子

生成sum函数的注释

以及下面的彩色注释

右键可以看到这个使用

此扩展程序提供以下设置：

• autoDocstring.docstringFormat：在不同的文档字符串格式之间切换
• autoDocstring.customTemplatePath：自定义文档字符串模板的路径（绝对或相对于项目根目录）
• autoDocstring.generateDocstringOnEnter：打开文档字符串后，按Enter即可生成文档字符串
• autoDocstring.includeExtendedSummary：在文档字符串中包括扩展摘要部分
• autoDocstring.includeName：在文档字符串的开头包含函数名称
• autoDocstring.startOnNewLine：摘要行之前的新行
• autoDocstring.guessTypes：从类型提示，默认值和变量名推断类型
• autoDocstring.quoteStyle：文档字符串的引号样式

• 设置页面,9个选项
• {{name}}-函数名称 {{summaryPlaceholder}}-[summary]占位符 {{extendedSummaryPlaceholder}}-[extended_summary]占位符
• {{#args}}-遍历函数参数 {{var}}-变量名 {{typePlaceholder}}-[type]或猜测的类型占位符 {{descriptionPlaceholder}}-[description]占位符 {{/ args}}

Ctrl+Shift+P

输入

Genertate Docstring会出现这个选项

或者在写好的函数下面

"""输入三个双引号的时候"""

然后摁Tab键就会自动生成

这个是效果图

这个是彩色的注释

这个下次再说为什么要安装这个库