本章基本概括
1.什么是注释，为什么要做注释
2.注释的目的与应用场景
3.注释的特点
4.单行注释和多行注释
5.使用注释应该注意哪些
一，什么是注释，为什么要做注释
-
什么是注释
- 注释就是对代码的解释和说明
- 注释可以是任何文字,也就是说可以直接写中文
- 注释只是为了提高可读性，不会被计算机编译。
- 在大多数开发工具中注释一般是绿色
-
为什么要做注释
- 注释就是对代码的解释和说明
- 目的是为了让别人和自己很容易看懂，一看就明白这段代码是用来做什么的
- 编写程序时，写程序的人给一个语句、程序段、函数等的解释或提示，能提高程序代码的可读性
- 最重要的是方便自己以后检查
-
温馨提示：
1.初学者编写程序应该养成习惯:先写注释再写代码或写完代码后立即写注释以防过后忘记
2.可以将自己的步骤先通过注释整理出来，然后再用代码去体现
3.代码是工具上的实现，注释是思考的一中表现
二，注释的目的与应用场景
- 常见用法一（解释代码）：
- (UIBarButtonItem *)initWithNorImage:(NSString *)norimage higImage:(NSString *)higImage title:(NSString *)title target:(id)target action:(SEL)action
{
// 1.创建一个按钮
UIButton *btn = [[UIButton alloc] init];
// 2.设置按钮的默认图片和高亮图片
if (norimage != nil &&
![norimage isEqualToString:@""]) {
// 图片不为空
[btn setImage:[UIImage imageNamed:norimage] forState:UIControlStateNormal];
}
if (higImage != nil &&
![higImage isEqualToString:@""]) {
// 图片不为空
[btn setImage:[UIImage imageNamed:higImage] forState:UIControlStateHighlighted];
}
// 设置标题
[btn setTitle:title forState:UIControlStateNormal];
// 3.监听按钮的点击事件
[btn addTarget:target action:action forControlEvents:UIControlEventTouchUpInside];
// 4.设置按钮的frame
// 可以调用控件的sizeToFit方法来自动调整控件的大小
[btn sizeToFit];
// 5.根据按钮创建BarButtonItem
return [[UIBarButtonItem alloc] initWithCustomView:btn];
}
- 常见用法二（做函数说明）：
/**
* 创建item
*
* @param norimage 默认状态的图片
* @param higImage 高亮状态的图片
* @param title 标题
*
* @return 创建好的item
*/
- (UIBarButtonItem *)initWithNorImage:(NSString *)norimage higImage:(NSString *)higImage title:(NSString *)title target:(id)target action:(SEL)action
{
// 1.创建一个按钮
UIButton *btn = [[UIButton alloc] init];
// 2.设置按钮的默认图片和高亮图片
if (norimage != nil &&
![norimage isEqualToString:@""]) {
// 图片不为空
[btn setImage:[UIImage imageNamed:norimage] forState:UIControlStateNormal];
}
if (higImage != nil &&
![higImage isEqualToString:@""]) {
// 图片不为空
[btn setImage:[UIImage imageNamed:higImage] forState:UIControlStateHighlighted];
}
// 设置标题
[btn setTitle:title forState:UIControlStateNormal];
// 3.监听按钮的点击事件
[btn addTarget:target action:action forControlEvents:UIControlEventTouchUpInside];
// 4.设置按钮的frame
// 可以调用控件的sizeToFit方法来自动调整控件的大小
[btn sizeToFit];
// 5.根据按钮创建BarButtonItem
return [[UIBarButtonItem alloc] initWithCustomView:btn];
}
- 常见用法三（做思路分析）：
以登录为例:
* 获取用户的输入信息.
* 判断输入的信息是否合乎规则.
* 登录密码加密.
* 把加密后的数据作为参数请求接口.
三，注释的特点
- 方便排除错误
- 检查代码时更快
- 从文件的大小可以间接看出注释后的代码并没有被编译
- 注释是写给人看的,不是给在计算机看的.因此当编译程序的时候,并不会将注释编译到目标文件中
四，单行注释和多行注释
- 单行注释：
- //进行单行注释
- 使用范围:任何地方都可以写单行注释:函数外
- 面、里面,每一条语句后面
- 作用范围:从第二个斜线到这一行末尾
- 快捷键: Command + /
- 多行注释：
- /***/ 进行多行注释
- 使用范围:任何地方都可以写多行注释:函数外面、里面,每一条语句后面
- 作用范围:从第一个/* 到最近的一个 */
五，使用注释应该注意哪些
- 1.单行注释可以嵌套单行注释、多行注释
// ios // 三年
// /* 三年 */
// iOS三年
- 2.多行注释可以嵌套单行注释
/*
// 作者:iOS三年
// 描述:复习很简单，就看你看不看“三年”
*/
- 3.多行注释时不能嵌套多行注释(错误写法)
/* 你好
/* ios */
三年 */
作者：确认过眼神啊
链接：https://juejin.cn/post/6899733038226210824
