美文网首页
代码规范

代码规范

作者: 安逸的Pig | 来源:发表于2016-03-01 00:01 被阅读0次

以前都是大牛读我的代码,现而今是我读一个菜鸟都算不上的菜逼的代码,你功能不能实现我不怪你,你做UI不细心我也可以理解,但是你告诉我BOOL falg是个什么东西,你再告诉我BOOL mark是个什么鬼,还有NSString *a,*h,你TM告诉你你想表达的是个啥?!!哦,No!!多么痛的领悟!也是因此,引出了“代码规范”这个词。


代码规范只是为了让别人阅读你代码时知道你是要干嘛,这样能提高效率,节省review的时间,提高debug的效率,而最根本的目的就是提高代码可读性。

对于命名,首要原则就是清晰。
大驼峰命名,即名字里所有单词首字母大写,其余字母小写。
小驼峰命名,即名字里除了首个单词全部用小写字母,其他单词均需要首字母大写。
类命名:直接使用大驼峰命名规则,用一个或多个单词来说明这个类,如果继承自Contrller则以...Controller结尾,如果集成自View或Button,则以View或Button结尾,如果是保存数据的实体,则以Model结尾。命名使用单词力求简单,不要过长。
如Masonry中:
    @interface MASExampleListViewController : UITableViewController
    @end
方法命名:使用使用小驼峰法,方法名第一个单词用动词,其首字母不需要大写,其后所有单词首字母大写。
变量名:除首个单词外,其他单词首字母大写,尽量使用较少的单词让人理解变量的意义。如果是局部变量,单词与单词间可以用_连接,首字母不需要大写,而全部变量,则用小驼峰法命名。

而在一个方法中,使用空行来区分方法中的模块,比如需要声明一个button和一个View,可以在写完关于button的代码后加一行空行再写关于View的代码。

如果你在写代码时会有上述习惯,恭喜你,应该不会有人在背后边读代码边问候你的亲戚朋友了。如果你想更清楚些,可以使用Pragma mark -- 给你文件中的代码分区。

如果需要更详细的规范,Google中会给你更多更好的建议。

相关文章

  • Web 端代码规范

    目录 1、代码规范概述 2、代码规范流程搭建 3、代码规范细则 1、代码规范概述 良好的代码规范能够提供软件的可读...

  • 代码规范

    代码规范 1. 概述 欢迎使用前端代码规范, 这里借鉴、引用的是京东前端代码规范。 遵循代码规范的目的在于增强团队...

  • iOS 代码规范篇

    iOS 代码规范篇 iOS 代码规范篇

  • iOS(OC)开发之随感

    1.代码规范 规范很重要!规范很重要!规范很重要! 代码规范的重要性之-为什么谷歌要执行严格的代码编写规范http...

  • 前端学习的基本总结

    目录 1.为什要遵守代码规范 2.css代码规范 3.js代码规范与设计模式3.1 js代码规范3.2 设计模式 ...

  • 乐乎项目优化

    编程: 1、代码规范。架构规范、文件组织规范、命名规范、代码逻辑规范、资源存放。 一、使用cocoapod 二、代...

  • 小肤iOS开发代码规范_v1.0

    For Objective-C , 2018.8.2 Ⅰ.前言Ⅱ.命名规范Ⅲ.代码注释规范Ⅳ.代码格式化规范Ⅴ....

  • 代码规范

    代码规范 1. 概述 欢迎使用代码规范, 这个是我借鉴京东前端代码规范,组织的内部规范。旨在增强团队开发协作、提高...

  • PSR-2- Coding Style Guide 编码风格规范

    代码风格规范 本篇规范是 PSR-1 基本代码规范的继承与扩展。 本规范希望通过制定一系列规范化PHP代码的规则,...

  • PM篇

    PM 技术篇1.开发规范命名规范,异常处理规范,日志规范,统一框架,代码commit规范,代码评审规范,统一API...

网友评论

      本文标题:代码规范

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