Take a look at GW

【Visual Studio】Visual C# 中XML注释的使用（含注释在开发时显示换行）

为函数方法注释说明要用到 xml 语句 <summary>　段落说明　</summary> 、<para>　新段示例说明　</para>、<para>　　</para>　空行要加入全角空格

下面的注释会破坏原有标注结构：

[csharp] view plain copy
  1. /// <summary> 第一行 说明  
  2. /// <para>第二行说明</para>  
  3. /// <para>　←最前面的空格要加入全角空格才会显示</para><para>　</para><para>　上面一行是空行</para>  
  4. /// <param name="s">　s 为表名，不要加 .xml 后缀</param>  
  5. /// <para>　异常：...</para>  
  6. /// <returns>　返回：成功 - true；失败 - false。</returns>  
  7. ///</summary>  
  8. private void getXmlTable(string s, DataGridView dataGView, ComboBox com, Button ton){}  


原语句：

[csharp] view plain copy
  1. /// <summary> 第一行 说明  
  2.         /// <para>第二行说明</para>  
  3.         /// <para>　←最前面的空格要加入全角空格才会显示</para><para>　</para><para>　上面一行是空行</para>  
  4.         /// <para>　</para>  
  5.         /// <para>　异常：《说明...》</para>  
  6.         ///</summary>  
  7.         /// <param name="s">　s 为表名，不要加 .xml 后缀</param> /// <returns>　返回：成功 - true；失败 - false。</returns>  
  8.         private void getXmlTable(string s, DataGridView dataGView, ComboBox com, Button ton){}  


。

原文链接：Visual C#XML注释的使用

posted @ 2017-11-04 10:13  HDWK  阅读(1410)  评论(0)  编辑  收藏  举报