提升自己逼格的编程之美之代码规范

头文件#import的顺序(商量)写法模板#import&lt;系统库>#import&lt;第三方库>#import“其他类”尽量按照先系统类第三方类自己写的类顺序导入中间不能有空格@Class的写法写法模板@classclass1,class2;@Interface的写法写法模板@interface类名:父类&lt;协议1,协议2>@interface和类名中间一个空格类名后紧跟:之后空格加上父类协议之间用,空格分割@protocol的写法写法的模板@protocol协议的名称&lt;协议1,协议2>@potocol和协议的名称有空格协议的名称和其他协议有空格其他协议之间 在编程世界中，代码规范是提高代码可读性、可维护性和团队协作效率的重要准则。以下是一些关于代码规范的详细说明，主要针对 Objective-C 语言： 1. **头文件导入顺序**： 应遵循的顺序是：系统库、第三方库、自定义类。例如： ```objc #import <SystemLibrary> #import <ThirdPartyLibrary> #import "MyCustomClass.h" ``` 保持这种顺序可以使代码更加整洁，避免不必要的冲突。 2. **@Class 使用**： 声明类时，使用 `@Class` 关键字，如： ```objc @Class Class1, Class2; ``` 这样做可以避免循环引用问题，同时保持代码简洁。 3. **@Interface 定义**： 接口定义时，注意类名与 `@interface` 之间、类名与冒号、冒号与父类、协议之间的空格，例如： ```objc @interface MyClass : NSObject <Protocol1, Protocol2> ``` 确保每个元素周围都有适当的空格。 4. **@protocol 定义**： 协议定义类似，需保持协议名称与其他协议之间的空格，例如： ```objc @protocol MyProtocol <Protocol1, Protocol2> ``` 5. **@property 的声明**： 属性声明时，使用逗号分隔关键词，确保类名前后有空格，例如： ```objc @property (nonatomic, strong) NSString *myString; ``` 6. **方法声明**： 方法参数应排列在同一行，方法之间保留空行。例如： ```objc - (void)myMethod:(NSInteger)param1 withParam2:(NSString *)param2; ``` 对于较长的方法，考虑拆分为多个方法以提高可读性。 7. **const 常量定义**： 使用 `k` 开头加类名首字母大写和常量作用名称，如 `kCVMNotificationUpdateCartList`，以防止重复。 8. **extern 声明**： 对于跨文件使用的常量，使用 `UIKIT_EXTERN` 或 `FOUNDATION_EXTERN`，否则只在实现文件中声明。 9. **pragma mark**： 使用 `pragma mark` 对方法进行分组，便于阅读和导航，例如： ```objc #pragma mark - 初始化方法 #pragma mark - 功能方法 ``` 10. **BOOL 属性声明**： `BOOL` 类型的属性，getter 应以 `is` 开头，setter 无需 `set` 开头，如： ```objc @property (nonatomic, getter=isFinished) BOOL finished; ``` 11. **方法命名**： 方法命名应遵循语义化，避免使用 `init` 和 `set` 作为非初始化和非属性设置方法的前缀。例如： ```objc - (void)startTask; - (void)updateLabelWithText:(NSString *)text; ``` 12. **控制结构**： `if` 语句中的条件应单独成行，方便断点调试，例如： ```objc if (condition1 && condition2) { // ... } ``` 13. **枚举（enum）定义**： 使用 `NS_ENUM` 或 `NS_OPTIONS` 定义枚举，使代码更具可扩展性，例如： ```objc NS_ENUM(NSInteger, MyEnum) { MyEnumValue1, MyEnumValue2 }; ``` 14. **控件命名**： 控件命名应反映其功能和类型，如 `titleLabel`、`imageView`。避免使用缩写，除非是广泛认可的，如 `UILabel` 结尾加 `Label`。 遵循这些代码规范，不仅可以提升代码质量，还能使得代码更易于理解，降低维护成本，增强团队间的合作效率。在实际开发中，持续实践和改进代码规范，将有助于个人和团队的成长，从而提升整体的编程水平。