代码槽点

作者: MicroCai | 来源:发表于2015-03-31 03:21 被阅读643次

    原代码

    typedef enum{
        UserSex_Man,
        UserSex_Woman
    }UserSex;
    
    @interface UserModel :NSObject
    
    @property(nonatomic, strong) NSString *name;
    @property (assign, nonatomic) int age;
    @property (nonatomic, assign) UserSex sex;
    
    - (id)initUserModelWithUserName:(NSString *)name withAge:(NSUInteger)age;
    
    -(void)doLogIn;
    
    
    @end
    

    枚举处有如下几个槽点

    • 不应该用 typedef enum 这种 C 形式定义枚举;既然做 iOS,就用 Apple 提供的东西。
    • 性别规范书面的命名是 Gender/Male/Female,而非 Sex/Man/Woman/Boy/Girl 之类。
    • 这一点可能是我多虑了:Male 和 Female 应该是互斥的,结构上用 Union 比较合适。但仍使用 enum 的原因两个:一是常用且易读;二是现实世界情况复杂,不排除极端情况。
    • 要有前缀,且前缀以三个字母为宜。前缀个数其实是有争议的,目前绝大多数的代码,包括流行的开源库都是两个字母前缀,究其原因可能是两个字母更好记,而且苹果也不会刚刚好使用到和我们代码相同两个字母,so……实际情况和要求还是出入的。

    类的地方有如下几个槽点

    • UserModel 的命名方式不太好。Model 是设计模型中的概念,不应该将其命名到具体的代码对象中,而且类型必须要有前缀,防止命名冲突,此处命名前缀取 BDK(Bai Du Knows)。
    • :NSObject 之间要有空格。
    • 属性定义的地方 property / 括号 / 类型 / *变量名 之间应该要有空格,此外符号 * 是和变量名紧贴。如 @property (nonatomic, copy) NSString* name; 就是一个不太好的命名习惯。
    • 括号内的修饰词按需按一定顺序排列,两个修饰词间的逗号后面应当有空格。具体的顺序没有硬性规定,我的习惯是 nonatomic 放前面,因为多数的属性修饰词都是 nonatomic,而其他修饰词却不一定一样,把 nonatomic 放前面看起来比较整齐。
    • NSString 类型变量用 copy 修饰比较安全。
    • 属性的类最好对齐。这点不知道算不算槽点,但对齐更好看(看下面的代码 NSString *userName; 和下面两行对齐)。
    • 属性 age 是非负整数,所以使用 int 不太好,而且最好不要使用 C 的类型,应该用 NSUInteger。
    • 方法本身的间隔类似的,参照下系统方法的命名,具体就不多说了,看我最终的代码间隔即可。
    • doLogIn 槽点太多:
      • 两个动词表示一个登录的意思,累赘不合理;
      • login 本身就是一个动词,如果非要拆开,应该是 logOn/logOff,而非 logIn;
      • 登录接口竟然没有参数。我使用了 NSDictionary 可以将所有登录需要的信息全放在里面,便于扩展和修改。
      • 登录方法没有返回值,无法了解登录情况,所以如果有个回调会更好。
    • 初始化方法的槽点也挺多:
      • 方法名中的 Model 和之前提到的问题一致;
      • 方法有返回值,所以方法名的开头应当是返回内容的名词形式,而非动词;
      • 根据方法名的意思推测,返回值应该是用户信息。既如此,应该直接用 BDKUserInfo 作为返回值类型。但也有可能这么做有其他用意,所以为了尊重原代码的意思,我还是将返回值设为 instancetype,返回一个关联类型。

    更正过的代码

    • 前缀 BDK 取 Bai Du Knows
    • 为什么类的属性和方法不加前缀?因为它们编译后不在顶级符号表。而且主流开源库的属性和方法命名时,也没有对类的属性和方法加前缀,已经约定俗成。从可读性的角度来说,加前缀是一种无奈之举,降低了代码的可读性。
    typedef NS_ENUM(NSInteger, BDKGender)
    {
        BDKMale,
        BDKFemale
    };
    
    @interface BDKUserInfo : NSObject
    
    @property (nonatomic, copy)   NSString *userName;
    @property (nonatomic, assign) NSUInteger userAge;
    @property (nonatomic, assign) Gender userGender;
    
    /**
     *  登录百度知道
     *
     *  @param info         登录所需信息
     *  @param successBlock 登录成功 block
     *  @param failedBlock  登录失败 block
     */
    - (void)loginWithInfo:(NSDictionary *)info
               successBlock:(void(^)(NSDictionary *resultInfo))successBlock
                   failed:(void(^)(NSError *error))failedBlock;
                   
    /**
     *  初始化用户信息
     *
     *  @param userName 用户名
     *  @param userAge  用户年龄
     *
     *  @return 用户信息
     */
    - (instancetype)userInfoInitialedByUserName:(NSString *)userName
                                         userAge:(NSUInteger)userAge;
                                    
    @end
    

    相关文章

      网友评论

        本文标题:代码槽点

        本文链接:https://www.haomeiwen.com/subject/pacoxttx.html