// 单行注释
/* */ 多行就不说了///是XML注解,简单的说,比如下面这个简单的例子:/// <summary>保存文件,成功返回null,否则返回错误信息</summary>
/// <param name="fileFullName">要保存的文件名</param>
/// <param name="fileBody">文件内容</param>
/// <returns>结果值</returns>
internal string SaveFileOf(string fileFullName,string fileBody) {
try{
FileStream ObjFile = new FileStream(fileFullName,FileMode.Create,FileAccess.Write,FileShare.Read);
StreamWriter sw = new StreamWriter(ObjFile,System.Text.Encoding.Default);
sw.Write(fileBody);
sw.Close();
ObjFile.Close();
return null;
}catch (Exception e){
return e.Message.ToString();
}
}其中各项并不是源代码注解,而是一个XML 形式的映射,你在用IDE时输入SaveFileOf 这时会自动弹出提示就是<summary></summary> 之间的内容,下面是参数也是一样自动提示,就好象VS自己的函数提示一样,包括重载次数等等。。如果该程序体是在dll 中,那么可以用 csc /t:savefile.dll /doc:savefile.xml savefile.cs输出一个xml 文件,你可以将这个xml 文件和DLL一起发布给第三方,那么在VS的IDE中引用该DLL时也会自动载入savefile.xml 从而起到了自动注解的作用(也就是所谓的CTRL+KI 的快速信息)

解决方案 »

  1.   

    补充一下:/// <summary>保存文件,成功返回null,否则返回错误信息</summary>
    /// <param name="fileFullName">要保存的文件名</param>
    /// <param name="fileBody">文件内容</param>
    /// <returns>结果值</returns>summary 是当前行往下数最近一个函数的作用注解(上例为SaveFileOf函数)
    param name=xxx 是该函数的各参数注解
    returns 是返回值注解还有<code></code>等都是常用的,这些在MSDN都有说明,你可前往查阅也就是说,你比如输入 MessageBox.Show 这时会有自动的提示(快速信息)说明它的重载次数、函数名及各参数,而你自己写的函数用上面的注解也可以做到这一点,这就是它的作用,对类、结构、函数等等都适用
      

  2.   

    是xml注释,vs可以用来生成xml文件前面师兄讲的很详细