【Visual Studio】Visual C# 中XML註釋的使用(含註釋在開發時顯示換行)
阿新 • • 發佈:2017-11-04
title visual toc sum .net art detail 段落 結構
為函數方法註釋說明要用到 xml 語句 <summary> 段落說明 </summary> 、<para> 新段示例說明 </para>、<para> </para> 空行要加入全角空格
下面的註釋會破壞原有標註結構:
[csharp] view plain copy- /// <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註釋的使用
【Visual Studio】Visual C# 中XML註釋的使用(含註釋在開發時顯示換行)