建議153：若拋出異常，則必須要註釋

建議153：若拋出異常，則必須要註釋

有一種必須加註釋的場景，即使異常。如果API拋出異常，則必須給出註釋。調用者必須通過註釋才能知道如何處理那些專有的異常。通常，即便良好的命名也不可能告訴我們方法會拋出那些異常，在這種情況下，使用註釋是最好的手段。

        /// <summary>
        /// 註釋
        /// </summary>
        /// <param name="value">輸入參數註釋</param>
        /// <returns>返回值註釋</returns>
        /// <exception cref="System.IO.IOException">如果……，則拋出IOException</exception>
        public string SampleMethod(int value)
        {
            if (true)
            {
                throw new IOException("一些IO異常");
            }
            //省略
        }

 

 

 

轉自：《編寫高質量代碼改善C#程序的157個建議》陸敏技