ios开发之注释规范

原文地址:http://blog.csdn.net/zeng_zhiming/article/details/68925543

1、代码的注释经常被人忽略，其实注解有很多好处：

（1）方便使用，会提示注解说明

（2）方便日后自己阅读代码

（3）方便别人阅读自己代码

（4）降低后期维护成本

（5）可以快速生成开发文档

2、代码的注释方式五花八门，好的代码注解应该是这样的：

（1）可以使用[Option + 单击]查看注解

（2）使用时可以提示注解（此方法只有头文件中属性/方法的注解才会提示）

（3）类的层级分明

3、注解方式一般分为四种

（1）单行注释(下面四种方式选自己喜欢的一种即可)

/// 单行注解.
@property (nonatomic,strong)NSString *proStr1;
//! 单行注解.
@property (nonatomic,strong)NSString *proStr2;
/** 单行注解. */
@property (nonatomic,strong)NSString *proStr3;
/*! 单行注解. */
@property (nonatomic,strong)NSString *proStr4;

（2）行尾注释(下面四种方式选自己喜欢的一种即可)

@property (nonatomic,strong)NSString *proStr5;/**<行尾注解. */
@property (nonatomic,strong)NSString *proStr6;/*!<行尾注解. */
@property (nonatomic,strong)NSString *proStr7;//!<行尾注解.
@property (nonatomic,strong)NSString *proStr8;///<行尾注解.

typedef enum : NSUInteger {
    MyEnumValueA, /**< 行尾注解. */
    MyEnumValueB, /*!< 行尾注解. */
    MyEnumValueC, //!< 行尾注解.
    MyEnumValueD, ///< 行尾注解.
} MyEnum;

（3）多行注释

/**
 计算两个数的和
 
 @param number1 加数1
 @param number2 加数2
 @return 相加结果
 */
- (NSInteger)sumWithNumber1:(NSInteger)number1 number2:(NSInteger)number2;

（4）方法集注释

#pragma mark - 初始化UI

4、注释快捷使用

（1）多行注释

Xcode8以后多行注释快捷键：[Command + Option + /]

（2）其它注释

其它注释可以添加为代码块来快捷使用：

/**< <#行尾注释#>. */
/*!< <#行尾注释#>. */
//!< <#行尾注释#>.
///< <#行尾注释#>.

/// <#单行注释#>.
//! <#单行注释#>.
/** <#单行注释#>. */
/*! <#单行注释#>. */

#pragma mark - <#方法集注解#>

原文地址:http://blog.csdn.net/zeng_zhiming/article/details/68925543

ios开发 之 注释规范

猜你喜欢

ios开发之注释规范