本章基本概括

1.什么是注釋疲扎，為什么要做注釋
2.注釋的目的與應(yīng)用場(chǎng)景
3.注釋的特點(diǎn)
4.單行注釋和多行注釋
5.使用注釋應(yīng)該注意哪些

一马胧，什么是注釋停撞，為什么要做注釋

• 什么是注釋

  • 注釋就是對(duì)代碼的解釋和說(shuō)明
  • 注釋可以是任何文字,也就是說(shuō)可以直接寫中文
  • 注釋只是為了提高可讀性壤蚜，不會(huì)被計(jì)算機(jī)編譯。
  • 在大多數(shù)開發(fā)工具中注釋一般是綠色

• 為什么要做注釋

  • 注釋就是對(duì)代碼的解釋和說(shuō)明
  • 目的是為了讓別人和自己很容易看懂修然，一看就明白這段代碼是用來(lái)做什么的
  • 編寫程序時(shí)笛钝，寫程序的人給一個(gè)語(yǔ)句、程序段愕宋、函數(shù)等的解釋或提示玻靡，能提高程序代碼的可讀性
  • 最重要的是方便自己以后檢查

• 溫馨提示：
1.初學(xué)者編寫程序應(yīng)該養(yǎng)成習(xí)慣:先寫注釋再寫代碼或?qū)懲甏a后立即寫注釋以防過(guò)后忘記
2.可以將自己的步驟先通過(guò)注釋整理出來(lái)，然后再用代碼去體現(xiàn)
3.代碼是工具上的實(shí)現(xiàn)中贝，注釋是思考的一中表現(xiàn)

二囤捻，注釋的目的與應(yīng)用場(chǎng)景

• 常見(jiàn)用法一（解釋代碼）：

- (UIBarButtonItem *)initWithNorImage:(NSString *)norimage higImage:(NSString *)higImage title:(NSString *)title target:(id)target action:(SEL)action
{
    // 1.創(chuàng)建一個(gè)按鈕
    UIButton *btn = [[UIButton alloc] init];
    // 2.設(shè)置按鈕的默認(rèn)圖片和高亮圖片
    if (norimage != nil &&
        ![norimage isEqualToString:@""]) {
        // 圖片不為空
        [btn setImage:[UIImage imageNamed:norimage] forState:UIControlStateNormal];
    }
    if (higImage != nil &&
        ![higImage isEqualToString:@""]) {
        // 圖片不為空
        [btn setImage:[UIImage imageNamed:higImage] forState:UIControlStateHighlighted];
    }
    // 設(shè)置標(biāo)題
    [btn setTitle:title forState:UIControlStateNormal];

    // 3.監(jiān)聽按鈕的點(diǎn)擊事件
    [btn addTarget:target action:action forControlEvents:UIControlEventTouchUpInside];
    // 4.設(shè)置按鈕的frame
    // 可以調(diào)用控件的sizeToFit方法來(lái)自動(dòng)調(diào)整控件的大小
    [btn sizeToFit];

    // 5.根據(jù)按鈕創(chuàng)建BarButtonItem
    return [[UIBarButtonItem alloc] initWithCustomView:btn];
}

• 常見(jiàn)用法二（做函數(shù)說(shuō)明）：

/**
 *  創(chuàng)建item
 *
 *  @param norimage 默認(rèn)狀態(tài)的圖片
 *  @param higImage 高亮狀態(tài)的圖片
 *  @param title    標(biāo)題
 *
 *  @return 創(chuàng)建好的item
 */
- (UIBarButtonItem *)initWithNorImage:(NSString *)norimage higImage:(NSString *)higImage title:(NSString *)title target:(id)target action:(SEL)action
{
    // 1.創(chuàng)建一個(gè)按鈕
    UIButton *btn = [[UIButton alloc] init];
    // 2.設(shè)置按鈕的默認(rèn)圖片和高亮圖片
    if (norimage != nil &&
        ![norimage isEqualToString:@""]) {
        // 圖片不為空
        [btn setImage:[UIImage imageNamed:norimage] forState:UIControlStateNormal];
    }
    if (higImage != nil &&
        ![higImage isEqualToString:@""]) {
        // 圖片不為空
        [btn setImage:[UIImage imageNamed:higImage] forState:UIControlStateHighlighted];
    }
    // 設(shè)置標(biāo)題
    [btn setTitle:title forState:UIControlStateNormal];

    // 3.監(jiān)聽按鈕的點(diǎn)擊事件
    [btn addTarget:target action:action forControlEvents:UIControlEventTouchUpInside];
    // 4.設(shè)置按鈕的frame
    // 可以調(diào)用控件的sizeToFit方法來(lái)自動(dòng)調(diào)整控件的大小
    [btn sizeToFit];

    // 5.根據(jù)按鈕創(chuàng)建BarButtonItem
    return [[UIBarButtonItem alloc] initWithCustomView:btn];
}

• 常見(jiàn)用法三（做思路分析）：

以登錄為例:
   * 獲取用戶的輸入信息.
   * 判斷輸入的信息是否合乎規(guī)則.
   * 登錄密碼加密.
   * 把加密后的數(shù)據(jù)作為參數(shù)請(qǐng)求接口.

三，注釋的特點(diǎn)

• 方便排除錯(cuò)誤
• 檢查代碼時(shí)更快
• 從文件的大小可以間接看出注釋后的代碼并沒(méi)有被編譯
• 注釋是寫給人看的,不是給在計(jì)算機(jī)看的.因此當(dāng)編譯程序的時(shí)候,并不會(huì)將注釋編譯到目標(biāo)文件中

四邻寿，單行注釋和多行注釋

• 單行注釋：

  • //進(jìn)行單行注釋
  • 使用范圍:任何地方都可以寫單行注釋:函數(shù)外
  • 面蝎土、里面,每一條語(yǔ)句后面
  • 作用范圍:從第二個(gè)斜線到這一行末尾
  • 快捷鍵: Command + /

• 多行注釋：

  • /***/ 進(jìn)行多行注釋
  • 使用范圍:任何地方都可以寫多行注釋:函數(shù)外面视哑、里面,每一條語(yǔ)句后面
  • 作用范圍:從第一個(gè)/* 到最近的一個(gè) */

五，使用注釋應(yīng)該注意哪些

• 1.單行注釋可以嵌套單行注釋誊涯、多行注釋

// ios // 三年
 // /* 三年 */
 // iOS三年

• 2.多行注釋可以嵌套單行注釋

/*
// 作者:iOS三年
// 描述:復(fù)習(xí)很簡(jiǎn)單挡毅，就看你看不看“三年”
*/

• 3.多行注釋時(shí)不能嵌套多行注釋(錯(cuò)誤寫法)

/*  你好
   /* ios */
   三年 */

作者：確認(rèn)過(guò)眼神啊
鏈接：https://juejin.cn/post/6899733038226210824