vs函数注释不显示备注

一般情况下，在vs中函数注释默认是不会显示备注的，如果要显示备注，可以通过以下步骤来实现：

1.在vs编辑器上点击“工具`-`选项”；

2.在d出的窗口中，找到“文本编辑器`-`C/C++`-`常规”；

3.点击“显示注释对话框中的备注”复选框；

4.点击“确定”按钮，即可完成备注显示的设置。

。C# 允许开发人员在源代码中插入VS XML注释，这在多人协作开发的时候显得特别有用。 C#分析器可以把代码文件中的这些XML标记提取出来，并作进一步的处理为外部文档。 这篇文章将展示如何 运用这些VS XML注释。作者演示了如何 生成工程，如何 把VS XML注释输出为有用文档，如何 把这些注释转变为帮助文件。 在项目开发中，很多人并不乐意写繁杂的文档。但是，开发组长希望代码注释尽可能细致；项目筹划人员希望代码设计文档尽可能详尽；测试、检查人员希望功能说明书尽可能细致等等。 假如这些文档都被要求写的话，保持它们同步比实行一个战役还痛苦。 为何不把这些信息保存在一个地点呢？？最明显想到的地点就是代码的注释中；但是你很难通览程序，并且有些须要这些文档的人并不懂编码。这篇文章将展示如何 通过运用 VS XML注释来处理这些疑问。代码注释、用户手册、开发人员手册、测试计划等很多文档可以很方便的从VS XML注释中取得。我将先演示如何 插入XML注释、如何 把这些XML注释导出为另一个文档。然后再讨论每个XML标记的意思，以及运用 XML和XSL生成帮助文件。所有的XML注释都在三个向前的斜线之后(///)。两条斜线表示是一个注释，编译器将忽略后面的内容。三条斜线告诉编译器，后面是VS XML注释，须要适当地处理。当开发人员输入三个向前的斜线后，Microsoft Visual Studio .NET IDE 自动检查它能不能在类或者类成员的解释的前面。假如是的话，Visual Studio .NET IDE 将自动插入注释标记，开发人员只须要添加些额外的标记和值。下面就是在成员函数前添加三个斜线，自动添加的注释。

楼主可以在VS自己写一个函数，然后在函数名上面一行直接敲出“///”,VS可以自动为你生成你这个函数的注释，summary中是你对这个函数功能的总结描述，param中是这个函数的参数，有返回值的函数会有return项，是函数的返回值。

这种注释与//的区别是：当你在其他地方调用这个函数时，在调用时可以很清除的看到///中注释的内容。而 //则没有这个功能。

---