Visual Studio2022快速生成函数说明注释
当我们写了一个函数之后
void my_strcpy(char* dest, char* src){}
想要写这个函数的说明文档,并且是写一个标准规范的,能够在我们想用这个函数的时候,当我们鼠标放到函数上就能够浮现这个函数的使用说明。
如下图所示:
实现这样效果的函数说明文档要怎么写呢?
很简单!Visual Studio提供了一种快捷的函数说明文档模板生成的方法,只需要在我们自己写的函数的函数头上方连续需要三个斜杠///
就能自动生成一个函数说明文档的模板,如下图所示:
当我们在函数头上方输入三个连续的反斜杠///
之后,Visual Studio马上就会帮我们生成一个函数说明文档
函数说明文档模板生成之后,我们只要按照这样的规范填入我们对函数的说明:
就可以实现我们文章开头所示的效果: