Skip to content

Latest commit

 

History

History
96 lines (75 loc) · 3.51 KB

vscode-preference.md

File metadata and controls

96 lines (75 loc) · 3.51 KB

vscode 代码规范配置

添加文件头

  • ctrl+shift+p -> snippets -> Preferences: configure user snippets

  • 选择常用编程语言,笔者以cpp,python为例,快捷键可任意设置,作者名和email和GitHub替换为你自己的,其他语言同理,注意不同语言注释写法

    • cpp.json

      {
 "Print to console": {
  "prefix": "cpy", // 快捷键
  "body": [
   "/*",
   " *Copyright (c) ${CURRENT_YEAR} All rights reserved",
   " *@description: $1",  // 按一下 tab 自动跳转到这里
   " *@author: Zhixing Lu",
   " *@date: ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE}",
   " *@email: luzhixing12345@163.com",
   " *@Github: luzhixing12345",
   "*/",
   ""
   ],
  "description": "copyright snippets"
 }
}

    • python

      {
 "Print to console": {
  "prefix": "cpy", // 快捷键
  "body": [
   "'''",
   "*Copyright (c) ${CURRENT_YEAR} All rights reserved",
   "*@description: $1",  // 按一下 tab 自动跳转到这里
   "*@author: Zhixing Lu",
   "*@date: ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE}",
   "*@email: luzhixing12345@163.com",
   "*@Github: luzhixing12345",
   "'''",
   ""
   ],
  "description": "copyright snippets"
 }
}

  • 新建项目之后输入cpy回车生成头文件信息,添加 description 即可

语言规范

CPP

vscode+cpplint

  1. 下载谷歌c++规范 pip install cpplint / 直接下载cpplint.py文件

  2. 搜索安装vscode插件cpplint

  3. 找到 cpplint.exe的下载位置, conda安装保存在 ~/Anaconda/envs/xxx/Script/cpplint.exe,或者直接下载cpplint.py文件并自定义路径

  4. 替换正确路径

    20220323034948

  5. 同位置下滑找到 verbose, 0最严格 5最松散 (0级有的地方你甚至感觉很离谱,规范性极高,推荐有一定基础或想提升自己规范的使用)

    20220323035153

  6. 笔者建议修改每行最大字符数,80对我来说有点太少了,100比较合适

  7. 如果问题出错不知如何修改,鼠标悬停至黄色波浪线->快捷修复->fix

  8. TODO:笔者本身是c++爱好者,打算编写cppcorrect用于自动纠正cpplint的警告信息(flag)

python

  1. ctrl+shift+p --> pylint -->ENTER
  2. 右下角安装pylint
  3. ctrl+shift+p --> pylint --> 启用代码检查 --> ENABLE

markdown

  1. 搜索安装vscode扩展 markdownlint

  2. ctrl+shift+p --> markdown --> create or open ... -> 自动生成.markdownlint.json

  3. 建议禁用以下三个MD规则,否则容易比较痛苦

    全规则

    {
"MD013": false, 
"MD003": false, // # ##的规则
"MD033": false  // html语法
}

  4. vscode+markdown的插件推荐