Question

C#中请问summary remark各是代表什么，应该写什么

用类视图的时候遇到的问题
为类添加注释的时候，点击summary之后出现的对话框
里面有两个框，分别是
summary
remark
这两个分别代表什么？一般情况下应该写什么？

在线等，HI在

Answer 1

Summary是最基本的描述，介绍这个类或者方法是干什么的。
Remarks是补充的说明，比如一些特别的注意事项、例外情况等等。

需要注意的是，Summary中添加的内容，你写的这个的类或者函数的使用者在代码编辑过程中的Intellisense提示框里可以看到；而remakrs的内容在Intellisense提示框中是看不到的。

Intellisense就是在写代码时，随着输入动态弹出来的提示你完整类名、函数名、参数、返回值、解释等的提示信息。

Answer 2

这些是代码的XML注释，即对代码的描述，在方法、属性、或字段的上一行按下///(三个反斜杠)VS会自动为你完成整段XML注释的标记。
这些XML注释会被VS的自动感知功能所引用，即当你通过.感知类的方法\属性、字段等还会有相应的文字说明，这些说明就是你在XML注释中添加的内容。
当你把你的程序模块封闭并生成DLL的时候，可以在生成时勾选同时输出XML注释文件，把生成的DLL和XML文件一同拷给别人，或是自己在其它 的项目中引用，就可以像在同一个解决方案中使用一样，VS的自动感知功能也会有文字提示的。