【C++】C++ 基础进阶【二】开发技巧

概述

文章目的： 分享高效快捷的开发技巧，提高开发效率，提升开发过程中的舒适感。

I - 集成开发环境

1.1 - IDE 组成

本章节主要分享一些便捷的功能使用

首先

什么是IDE，它包含哪些功能 ？

集成开发环境，Integrated Development Environment ，简称 IDE。

主要有以下功能：

• 提高开发效率
• 工程管理
• 代码跳转
• 自动生成 makefile 等

makefile 主要用于建立文件之间工程之间的依赖和连接... 主要体现在编译过程...

一般包含三个部分？

1. 文本编辑器 (text editor)，提供自动补全，语法错误回显，语法/关键字高亮...

2. 编译器 (compiler) ，例如 MSVC, gcc/g++, MinGW...
   MinGW = Minimalist GNU for Windows，很多库默认不对此编译器做支持，如 QWebEngine，Windows 上一般开发尽量使用 MSVC。

3. 调试器 (debugger)

1.2 - 便捷方法

1.2.1 - 块选/块编辑

用途:

平时代码选中为行选，有些情况下我们不需要整行的内容，只需要其中一部分内容。

使用方法:

Visual Studio 及 Qt 中，按下键盘 Alt 键，使用鼠标左键选中。

Visual Studio Code 中，则只需按下鼠标中键拖动选中。

块编辑，意思是多行复写，多行写同样的内容，支持复制粘贴，例如下图

右侧我们可以多行复写多个变量名称 tima，对于定义的结构体，我们可以选中所有的成员变量，并跳过类型，直接粘贴在右侧。省去了一个一个敲或者粘贴的时间。

1.2.2 - 分页

需要多个文件/单个文件不同处编辑或对照代码时，分页可以便捷查看。

Visual Studio 中

• 创建选项卡, "窗口 (Window)" → "新建水平选项卡组 (New Horizontal Tab Group)" / "新建垂直选项卡组 (New Vertical Tab Group)"

• 单文件上下拆分，"窗口 (Window)" → "拆分 (Split)"

两种方式都没有默认快捷键，但可自定义。

"工具 (Tools)" → "选项 (Options)" → "环境 (Enivronment)" → "键盘 (Keyboard)" → 输入快捷键 → 检查无冲突后 → "分配 (Assign)"

1.2.3 - 书签，浏览

用途

多处代码需要查看，添加标签，便于快速切换浏览

使用方法

Visual Studio ，需要在鼠标标记处创建书签，显示书签窗口，双击用于切换至书签位置

其他位置快速切换

1.2.4 - 代码生成

用途：

快速生成函数实现，一个函数包含的必要代码 (类名，函数签名，两个大括号，默认返回值)

使用方法：

在函数声明处按下 Alt + 回车，出现菜单后再次回车，默认选项为在对应的源文件中生成函数实现的必要代码。

左图为 Qt，右图为 Visual Studio

1.2.5 - 注释生成

用途：

用于生成注释模板，有些 IDE 如 Qt 内置支持 doxygen 格式的注释

使用方法：

Qt 默认的使用方法为在函数前一行，敲 /** 或 /// 后回车，会生成两种不同风格的注释，见下图

Visual Studio 和 Visual Studio Code 默认不支持，但是可以通过安装插件或扩展来实现

• DoxygenComments (for Visual Studio)
• cschlosser.doxdocgen-1.2.0.visx (for Visual Studio Code)

扩展不唯一，下载位置：

https://marketplace.visualstudio.com/vscode

1.2.5.1 - Doxygen

首先，Doxygen 是什么？
简而言之，开发文档生成工具，和一套注释规范。

开发文档

开发文档 - developer guide，比如第三方库或开源库的使用说明，github库中的 readme，工程的简介概述，如何在操作系统中部署，以及在代码中如何使用 (初始化，设置...) 等。

工作原理

使用按照规范编写的注释，则可被 doxygen 软件识别，转换成说明文档，并通过代码分析，提取代码结构继承关系等，生成一个有各种开发人员需知内容的参考手册。

可识别的注释三种：

• JavaDoc

  /**
  * ...批注...
  * /
  

• Qt

  /*!
  * ...批注...
  * /
  

• 单行式批注

  /// ...批注...
  
  //! ...批注...
  

另有一些特定标签用于结构化数据
使用 @ 或 \ 打头紧跟标签名称示例

/// @param
/// \param

一些注意事项：

• // 的注释 doxygen 无法识别
• 不要在头文件和源文件中重复书写同样的文件头内容，会被识别两次，在手册中产生重复冗余的内容，文件头注释只需写在头文件中即可
• 需要使用 正确的 doxygen 的内置标签 ，自定义标签无法识别，拼写错误的标签一样无法识别，如 detail 无法识别。需要写成 details 多一个 s

  1.2.5.2 - 扩展使用

DoxygenComments 的安装配置方法

• 1 关闭 Visual Studio，双击进行安装
• 2 安装完成后，打开 Visual Studio 进入此插件的设置 "工具 (Tools) " → "选项 (Options) " → "Doxygen "
• 3 Default 子选项内容清空，防止引起冲突

• 4 Function 子选项用于设置函数注释模板，清空并替换为以下内容

    /// \brief  $END
    /// \param $PARAM
    /// \return $return
  

• 5 Header 子选项用于设置头文件注释模板，清空并替换为以下内容

    //---------------------------------------------------------
    /// \file    $FILENAME
    /// \brief     $BRIEF $END
    /// \version
    /// \author
    /// \data    $YEAR/$MONTH/$DAY_OF_MONTH
    //---------------------------------------------------------
  

使用时，在头文件第一行输入 //- 即可触发头文件注释模板
在函数声明前一行输入 /// 后回车即可生成函数注释模板

cschlosser.doxdocgen Visual Studio Code 扩展使用

安装完成后，进入此扩展的设置。

• Doxdocgen > C:Comment Prefix 设置为 /// 三斜杠后写一个空格
• Doxdocgen > C: First Line & Last Line 清空
• Doxdocgen > Generic Param Template 设置为 \param {param}
• Doxdocgen > Order > Edit in settings.json

{
   
    "doxdocgen.generic.order" : [ "brief", "param", "return" ],
}

1.2.5.3 - 颜色设置

有一些 doxygen 注释的默认显示颜色比较暗有点伤视力，可以通过以下方法设置为一些明亮的颜色。

Visual Studio：

" 工具 (Tools)" → " 选项 (Options) " → "环境 (Environment) " → "字体和颜色 (Fonts and Colors) " → "显示项 (Display items)" 中找到 "XML 文档注释 (XML Doc Document) "

设置 " 项前景 (Item foreground) " 的 " 自定义 (Custom...) " 选择一个比较明亮的颜色。

Qt：

工具 → 选项 → 文本编辑器 → 修改 "Doxgen 注释" 和 "Doxgen 标签" 的 "前景颜色"

(需要先复制颜色主题才可以修改)

Visual Studio Code

"设置" → "文本编辑器" → "Font Ligatures" → "在 settings.json 中编辑"

输入以下内容

关于 scope 如何确定 scope 的名称，ctrl + shift + p
Developer: Inspect Editor Tokens and Scope

1.2.5.4 - Doxygen 其他工具

Graphviz:

绘图工具，生成类之间文件之间关系图，函数调用等，比 doxygen 自身的绘图要详细很多。下载位置：

https://www.graphviz.org/download

HTML Helper Workshop:

压缩 html 文件，生成 .chm 格式手册，下载位置：

https://www.helpandmanual.com/downloads_mscomp.html

关于如何使用 doxygen 见链接：

知乎 doxygen 使用指南

https://zhuanlan.zhihu.com/p/404148142

doxygen 官网

https://www.doxygen.nl/index.html

1.2.6 - 其他快捷键

以下使用的快捷键为 Visual Studio 2019 ，其他版本的 Visual Studio 或有不同。

折叠所有方法，不仅折叠函数方法，还会折叠宏定义、很适合多重宏隔离的代码开发。

Qt 中