分享免费的编程资源和教程

网站首页 > 技术教程 正文

Visual Studio2017开始使用Doxygen风格的文档化注释

goqiw 2024-10-08 06:51:41 技术教程 21 ℃ 0 评论

从Visual Studio 2017版本起,我们可以在C/C++代码中使用Doxygen风格的文档化注释了。当然,Visual Studio默认使用的XML形式的文档化注释,主要为C#语言服务的。因此,我们需要做一些简单的设置即可对C/C++代码使用Doxygen风格的文档化注释。笔者接下去将以自己所使用的Visual Studio 2022 Community Edition为例,为大家介绍如何进行配置。

首先,我们用打开一个C/C++语言的项目工程,然后在菜单栏点击 “工具” 选项,如下图所示:


接着,展开“文本编辑器”,再展开“C/C++”,最后展开“代码样式”。然后我们可以看到右侧“生成的文档注释样式”这一栏默认选中的是“XML 文档注释”。因此,我们只需要将这里选择为“Doxygen (/**)”即可,如下图所示。


Doxygen提供了多种文档化注释风格,比如还有 /*! 等等。

我们这里使用 /** 这种文档化注释风格也是为了能与其他IDE相互兼容。
比如,Xcode也能支持 /** 这种风格的Doxygen文档化注释。

完成之后,我们可以试试。当我们写出 /** 之后然后换行,我们就能看到Visual Studio编辑器会自动出现Doxygen注释的模板,如下图示。

当我们把鼠标光标移动到main函数之后就能看到对它清晰的文档化说明了。是不是看起来更舒服了?

本文暂时没有评论,来添加一个吧(●'◡'●)

欢迎 发表评论:

最近发表
标签列表