【Visual Studio】Visual C# 中XML注释的使用(含注释在开发时显示换行)
为函数方法注释说明要用到 xml 语句 <summary> 段落说明 </summary> 、<para> 新段示例说明 </para>、<para> </para> 空行要加入全角空格
下面的注释会破坏原有标注结构:
- /// <summary> 第一行 说明
- /// <para>第二行说明</para>
- /// <para> ←最前面的空格要加入全角空格才会显示</para><para> </para><para> 上面一行是空行</para>
- /// <param name="s"> s 为表名,不要加 .xml 后缀</param>
- /// <para> 异常:...</para>
- /// <returns> 返回:成功 - true;失败 - false。</returns>
- ///</summary>
- private void getXmlTable(string s, DataGridView dataGView, ComboBox com, Button ton){}
原语句:
- /// <summary> 第一行 说明
- /// <para>第二行说明</para>
- /// <para> ←最前面的空格要加入全角空格才会显示</para><para> </para><para> 上面一行是空行</para>
- /// <para> </para>
- /// <para> 异常:《说明...》</para>
- ///</summary>
- /// <param name="s"> s 为表名,不要加 .xml 后缀</param> /// <returns> 返回:成功 - true;失败 - false。</returns>
- private void getXmlTable(string s, DataGridView dataGView, ComboBox com, Button ton){}
。
原文链接:Visual C#XML注释的使用