繼上一篇筆記之後，今天我們討論一下 代碼中是存在註釋是否是一件好的事情。
在我們開發的過程中講究“名副其實，見名識意”，這也往往是很多公司的要求，但是有了這些要求是不是我們的代碼中如果存在註釋是不是意味着我們的 函數，變量，以及類 的命名就不符合了“名副其實，見名識意”。
我們先區分一下註釋的類別，註釋一般分為以下幾種：
- 1， 單行註釋
- 2， 多行註釋
- 3， 文檔註釋
- 4， #region 摺疊註釋，可以將 代碼摺疊
註釋的類別
1， 單行註釋：
在以 “//” 開頭，用以說明一行代碼的作用放置位置 看習慣或者公司要求合理就行。常用於函數內部，在很多的開源代碼中文件的頭部我同樣見到很多人使用單行註釋進行說明，靈活就好。
體現形式如下：
public List<string> getVipUserNameByUserType() { // Vip user name list var vipUserNames = new List<string>(); foreach (var user in Users) { if (user.Type = "VIP") vipUserNames.Add(user.Name); } return vipUserNames; }
View Code
2， 多行註釋：
以“/*”開頭 “*/” 結尾 常用於描述說明一段代碼以及類註釋或者說代碼塊常用於文件的頂部。說明作者信息，時間如果是開源的這包含開源的更多說明。
通常使用如下:
/* * 作者：〈版權〉 * 描述：〈描述〉 * 創建時間：YYYY-MM-DD * 作用： */
View Code
3， 文檔註釋：
也就是常用的XML 註釋：它的說明性更加的強烈，多用於類以及函數上，當然屬性上同樣可以使用：
如下所示：
/// <summary> /// MyClass /// </summary> public class MyClass { /// <summary> /// MyProperty /// </summary> public int MyProperty { get; set; } /// <summary> /// MyMethod /// </summary> public void MyMethod(){ } }
View Code
以下是官方建議的文檔標記 點擊標籤會制動跳轉
4， #region ： 摺疊註釋，常用於描述多個函數的基本作用
書中最喜歡的話
好的註釋不能美化糟糕的代碼，真正好的註釋是你想盡辦法不去謝的註釋。懷註釋都是糟糕代碼的支撐或借口，或者是對錯誤決策的修正。
下面看一個例子
//Check to see if the employee is eligible for full benefits （1）If((employee.flags & HOURLY_FLAG)&& (employee.age>65)) （2）If(employee.isEligibleForFullBenefits())) 這兩個你更喜歡哪個
View Code
好的註釋的特徵：
1：表示法律信息（這樣的註釋一般出現在文檔頂部說明作用以及協議）
// Copyright (c) .NET Foundation. All rights reserved // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
View Code
2：提供信息的註釋（指無法通過命名提供信息如要 註釋輔助的）
public void ConfigureServices(IServiceCollection services) { // These two middleware are registered via an IStartupFilter in UseIISIntegration but you can configure them here. services.Configure<IISOptions>(options => {}); }
View Code
3：對意圖的解釋
4： 警示：告知其他人會出現某種後果的註釋
5： TODO註釋： 主要描述應該做的目前還沒有做的事情。
6： 放大：提示不合理之物的重要性。
應避免的註釋
應該避免以下幾點：
1： 誤導性註釋
2： 日誌式註釋
3： 廢話註釋
4： 標記位置的註釋
5： 括號后的註釋
6： 歸屬與簽名
7： 註釋掉的代碼
8： Html 註釋
以上沒有一一舉例的原因是我的PPT是一份演示的PPT，裏面很多公司的代碼不便貼出，抱歉。
不足之處還請指出
本站聲明:網站內容來源於博客園,如有侵權,請聯繫我們,我們將及時處理【其他文章推薦】
※公開收購3c價格,不怕被賤賣!
※想知道網站建置、網站改版該如何進行嗎?將由專業工程師為您規劃客製化網頁設計及後台網頁設計
※不管是台北網頁設計公司、台中網頁設計公司，全省皆有專員為您服務
※Google地圖已可更新顯示潭子電動車充電站設置地點!!