0

    一篇走心的 iOS 代码规范

    2023.04.19 | admin | 160次围观

    ↓推荐关注↓

    前言

    关于代码规范的重要性这里不做过多解释,能看到这篇文章说明你已经开始重视代码规范了(代码规范看起来是在限制你的自由和发挥,其实它是在间接的帮助你变得更优秀。)。

    适当的代码规范和标准绝不是消灭代码内容的创造性、优雅性,而是限制过度个性化,以一种普遍认可的统一方式一起做事,进而提高工作效率,降低沟通成本。

    代码的字里行间流淌着的是软件和程序员的血液,质量的提升是尽可能少踩坑、杜绝踩重复的坑,切实提升系统稳定性yy协议软件上下号时间源码,码出质量(摘抄自《阿里巴巴Java代码规范》)。

    根据约束力度,暂时把规范约定为2个等级,分别是 [必须] 和 [建议]。

    (一)命名规范1. 通用命名规范

    Tips:
    所有的命名都应该遵循3个基本原则,即“清晰性”、“一致性”、“不要自我指涉”。

    2. 类命名规范

    WXYZ_LoginViewControler WXYZ_表示前缀,Login表示该类跟登录相关yy协议软件上下号时间源码,ViewController表示该类是一个视图控制器而不是View。```

    3. 方法命名规范4. Protocol命名规范5. Category命名规范6. Notification命名规范7. 常量命名规范8. Exception命名规范9. 文件命名规范(二)编码规范1. 通用编码规范2. 类编码规范3. 方法编码规范4. Block编码规范5. 通知编码规范6. 注释编码规范(三)工程结构规范结语

    这只是一篇关于iOS的代码规范,所以某些需要和服务端需要统一的规范(例如错误码)并没有提到,还有些关于如何编写安全代码方面的规范也只是略微提到,因为关于如何写出更安全的代码应该不属于代码规范层面;欢迎大家提出更好的建议或改进,我也会不断更新完善;最后祝大家码出开心,码出质量。

    下载链接[1]参考

    Cocoa编码规范[2]

    阿里巴巴Java代码规范[3]

    Effective Objective-C 2.0 编写高质量iOS与OS X代码的52个有效方法[4]

    网上其他人发布的有关代码规范的文章

    参考资料

    [1]

    %E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83.md

    [2]

    [3]

    [4]

    版权声明

    本文仅代表作者观点。
    本文系作者授权发表,未经许可,不得转载。

    标签: ios
    发表评论