Object-c 程式碼註解

摘要:Object-c 程式碼註解

每種語言都有註解, Object-c自然不在例外. 小弟文采不好, 所以不怎麽寫帖子, 各位看家不要見怪. XD! 話說回來今天講講Object-c 程式碼的幾種註解吧!

 

屬性成員 : 

1 . 主要用於在.h 中方便 Xcode 提示屬性成員的作用


@interface WTAppAssestManager ()

//Data Property
@property (nonatomic, strong) NSArray *localAppList;                     /* < 本地 ipa清单 */
@property (nonatomic, strong) NSArray *upgradeAppList;                   /* <  可升级 ipa 清单 */
@property (nonatomic, strong) NSArray *ignoreUpgradeAppList;             /* <  忽略升级清单 */

@end

2. 一般用於.m 閱讀時方便理解

@interface WTAppAssestManager ()

 

//Data Property

@property (nonatomic, strong) NSMutableArray *localAppList;                     //本地 ipa清单

@property (nonatomic, strong) NSMutableArray *upgradeAppList;                  //可升级 ipa 清单

@property (nonatomic, strong) NSMutableArray *ignoreUpgradeAppList;            // 忽略升级清单 

 

@end

 

函式註解 : 

 

1. .m 內部函式註解

//Loading Cache

- (id)loadCacheFile:(NSString *)cacheFile{

     //Codeing here

 

}

 

2. .h 公開函式註解 (推薦 tips:Python 似乎也是這種註解)

/**

 *  添加 ipa

 *

 *  @param files Package Files

 */

- (void)addPackages:(NSArray *)files;