1. 程式人生 > >C#xml註釋 換行、空行

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){}