• 自定义代码片段
  1. 文件>首选项>用户代码片段
  2. 搜索python
  3. 添加代码
  1. "HEADER":{
  2.         "prefix": "header",
  3.         "body": [
  4.             "# -*- encoding: utf-8 -*-",
  5.             "",
  6.             "# @File    : $TM_FILENAME",
  7.             "# @Time    : $CURRENT_YEAR/$CURRENT_MONTH/$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE:$CURRENT_SECOND",
  8.             "# @Author  : H2o ",
  9.             "# @Version : 1.0",
  10.             "# @Contact : 515430193@qq.com",
  11.             "",
  12.             "",
  13.             ""
  14.         ],
  15.     }
  • 添加文件头
  1. 新建文件
  2. 输入header
  3. 选择header
  1. 在vscode中打开一个文件
  2. 点击左下角”齿轮”图标
  3. 选中设置
  1. 设置界面, 切换tab到工作区
  2. 设置搜索框输入:python.pythonPath
  3. 将新建的虚拟环境地址添加即可, 如: D:\ENV\Testtools\Scripts\python.exe
  1. 下载插件: autoDocstring

  2. 快捷键: ctrl+shift+2, 或在函数定义后输入: “””

  3. 设置界面, 搜索autoDocstring

  4. 修改autoDocstring.docstringFormat栏即可

  5. 新建.mustache文件
  6. 修改autoDocstring.docstringFormat栏为default

  7. 修改autoDocstring.customTemplatePath为你新建的.mustache文件的地址

(详细关键字配置请查看插件介绍)

个人使用google注释模板,.mustache文件内容如下:

  1. {{! Google Docstring Template }}
  2. {{summaryPlaceholder}}
  3. {{extendedSummaryPlaceholder}}
  4. {{#parametersExist}}
  5. Args:
  6. {{#args}}
  7.     {{var}} ({{typePlaceholder}}): {{descriptionPlaceholder}}
  8. {{/args}}
  9. {{#kwargs}}
  10.     {{var}} ({{typePlaceholder}}, optional): {{descriptionPlaceholder}}. Defaults to {{&default}}.
  11. {{/kwargs}}
  12. {{/parametersExist}}
  14. {{#exceptionsExist}}
  15. Raises:
  16. {{#exceptions}}
  17.     {{type}}: {{descriptionPlaceholder}}
  18. {{/exceptions}}
  19. {{/exceptionsExist}}
  21. {{#returnsExist}}
  22. Returns:
  23. {{#returns}}
  24.     {{typePlaceholder}}: {{descriptionPlaceholder}}
  25. {{/returns}}
  26. {{/returnsExist}}

(以black为例)

  1. pip install black
  2. 设置界面, 搜索python.formatting.provider, 选择black
  3. 设置界面, 搜索python.formatting.blackPath, 输入你的black安装路径
    例如: C:\Program Files\Python36\Scripts\black.exe
  4. (选配)配置black运行参数, 设置界面, 搜索python.formatting.blackArgs, 添加: –line-length=80

    (black每行允许的字符长度为88)

(以pylint为例)

  1. pip install pylint (若是虚拟环境, 建议切换到虚拟环境后, 再pip安装)
  2. 设置界面, 搜索python.linting.pylintPath, 输入你的pylint安装的路径
  3. 设置界面, 搜索python.linting.enabled, 选中即可
  4. 设置界面, 搜索python.linting.pylintEnabled, 选中即可
项目 说明 是否必需安装
Python 是
vscode-icons 美化文件图标 否
Better Comments 美化行注释 否
Chinese (Simplified) Language Pack
for Visual Studio Code		 中文汉化包 否
autoDocstring 函数注释模板生成 否 
  1. {
  2.     "files.autoSave": "afterDelay",
  3.     "editor.renderWhitespace": "all",
  4.     "editor.wordWrap": "wordWrapColumn",
  5.     "workbench.startupEditor": "newUntitledFile",
  6.     "workbench.iconTheme": "vscode-icons",
  7.     "workbench.colorTheme": "Bluloco Light",
  8.     "editor.fontFamily": "InputMono, Consolas, 'Courier New', monospace",
  9.     "editor.fontSize": 15,
  10.     "editor.lineHeight": 27,
  11.     "python.formatting.provider": "black",
  12.     "python.formatting.blackPath": "C:\\Program Files\\Python36\\Scripts\\black.exe",
  13.     "python.formatting.blackArgs": [
  14.         "--line-length=80"
  15.     ],
  16.     "editor.renderControlCharacters": false,
  17.     "autoDocstring.customTemplatePath": "C:\\Program Files\\Microsoft VS Code\\data\\google.mustache"
  18. }
  1. {
  2.     "python.pythonPath": "D:\\ENV\\Testtools\\Scripts\\python.exe",
  3.     "python.linting.pylintEnabled": true,
  4.     "python.linting.enabled": true,
  5. }

版权声明：本文为TesterH2o原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://www.cnblogs.com/TesterH2o/p/11548086.html