注释规范

创建文件

文件前缀：DD代表xx的文件
文件命名：DD+功能描述+类型，例如历史订单列表控制器：DDHistoryOrderListController

注释

类的注释

创建完类之后，需要在如下部分写清楚文件作用：

//
//  ViewController.h
//  test
//
//  Created by dry on 2017/9/18.
//  Copyright © 2017年 dry. All rights reserved.
//
//  类功能描述
//

#import <UIKit/UIKit.h>

@interface ViewController : UIViewController

@end

属性注释

属性

//
//  DDUser.h
//  test
//
//  Created by dry on 2017/9/18.
//  Copyright © 2017年 dry. All rights reserved.
//

#import <Foundation/Foundation.h>

@interface DDUser : NSObject

//  姓名
@property (nonatomic, strong) NSString *name;
//  年龄
@property (nonatomic) NSUInteger age;


@end

变量

@interface ViewController ()
{
    NSString *_city;//城市
    NSString *_cityCode;//城市编码
}
@end

方法注释

头文件中

1、不携带参数的方法直接用///+描述
2、携带参数的方法统一用cmd+option

/// Description
- (void)startRunning;

/**
 <#Description#>

 @param date <#date description#>
 */
- (void)startRunningWithDate:(NSDate *)date;

顺序：类引用，宏定义，枚举，代理，属性，方法

源文件中

源文件中

方法注释用//或cmd+option，视情况定

方法需要分类，一类定义一个mark，比如：

#pragma mark - Timer

关于timer的方法都在这

#pragma mark - delegate

代理方法都在这

注意：改对方写的方法时，方法注释里写上自己名字英文简写，比如：MX,BJB,LX,WWP。每次修改更新最新的名字简写。在自己创建的类中不用写自己名字，但是如果有别人修改过，你再改得时候需要更新名字简写。