首页 > 代码库 > 注释模板
注释模板
注释的原则：就是为了让代码具有可读性
外部属性（就是让外部可以读取或写入的）
在.h文件里面用文档注释清楚，便于外部的使用
内部属性（类部自己读写的）
在.m文件的私有扩展里面用文档注释清楚，内部调用时可以清楚看到属性的作用
外部方法（让外面调用的）
在.h文件里面用文档注释清楚，便于外部的使用
内部方法（自己私有）
在.m文件的私有扩展里面用文档注释清楚，内部调用时可以清楚看到该方法的作用的
在复杂的.m文件中可以用(pragma mark - )把代码分成以下几个部分
- 生命周期方法(life circle)
- 懒加载(lazy load)
- 内部方法（定义方法用文本注释.m文件）(inner action)
- 外部方法 （定义方法用文本注释.h文件）(external action)
- 数据源方法(datasource)
- 代理方法(delegate)
以下为注释示例模板
GJViewController.h
#import <UIKit/UIKit.h>
@interface GJViewController : UIViewController
/** 自定义的按钮 */
@property (nonatomic,strong) UIButton *customBtn;
/**
* 构造方法
*
* @param nibNameOrNil nib名称
* @param nibBundleOrNil nib路径
*
* @return 控制器对象
*/
- (id)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil;
/**
* 外部测试方法
*/
- (void)externalTest;
@end
GJViewController.m
#import "GJViewController.h"
@interface GJViewController ()
/** buttons */
@property (nonatomic,strong) NSMutableArray *buttons;
@end
@implementation GJViewController
#pragma mark - lazy load
- (NSMutableArray *)buttons
{
if (_buttons == nil) {
_buttons = [NSMutableArray array];
}
return _buttons;
}
#pragma mark - constructor
- (id)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil
{
self = [super initWithNibName:nibNameOrNil bundle:nibBundleOrNil];
if (self) {
}
return self;
}
#pragma mark - life circle
- (void)viewDidLoad
{
[super viewDidLoad];
}
- (void)didReceiveMemoryWarning
{
[super didReceiveMemoryWarning];
}
#pragma mark - inner action
/**
* 内部方法
*/
- (void)innerTest
{
}
#pragma mark - external action
- (void)externalTest
{
}
#pragma mark - datasource
- (void)datasurce
{
}
#pragma mark - delegate
- (void)delegate
{
}
@end
注释模板