善用#waring,#pragma mark 标记

  在项目开发中,咱们不可能对着需求一口气将代码都写好。开发过程当中确定遇到诸如需求变更,业务逻辑沟通,运行环境的切换等这些问题。当项目大的时候,若是木有造成统一的代码规范,在项目交接和开发人员沟通上将会带来很大的麻烦。程序员

  #pragma mark -网络

  这个标记在iOS开发中用得最多了。其实最主要的是用来进行标记的,固然也有注释的做用在里面。固然咱们也能够用//,/* */等经常使用注释来讲明。可是用#pragma mark -不一样的是能够将整个文件的函数以相似分组的形式展示。当咱们点击Xcode 导航栏上面的文件后面的列表时将会获得如图所示的界面:函数

这样当其余开发者查看此文件时,能够清晰的看到整个函数分布,也清晰的知道各个功能相关的函数。若是鼠标点击其中的标记能够直接跳到此标记的位置,很是的方便。当进行业务上沟通和调用时很是省时省力。用#pragma mark -还有一个好处就是在开发中咱们常常会实现其余类的delegate,datasource,protocol等,若是咱们#pragma mark - UITableViewDelegate,当咱们用鼠标加上command点击UITableViewDelegate会直接跳到这个delegate定义的地方,能够方便的查看相关方法。我的对#pragma mark - 做用的理解是便于开发者之间相互交流。特别是多人的大项目时,若是你们都按各自喜爱随便使用#pragma mark - 那么对于项目开发和维护来讲是很是灾难性的。不只开发者本身不清楚本身的整个文件的结构,当其余开发者进行接手开发时将是件很是头大的事情。因为objc函数命名时具备口语化的特色,函数一看名字就知道其要实现的功能,因此日常开发中只写一些关键性说明的注释,如bool变量的说明,业务处理的逻辑等。结合#pragma mark - 能够很方便的让其余开发者理解。测试

#waring ui

  这个更加建议你们使用,Xcode默认支持了将#waring标记以编译警告的形式显示出来。在软件开发中,你们都会用TODO,FIXME,XXX等特殊注释。这些关键字也被不少IDE所支持。若是在代码中加入#warning 此处须要修改 by james,在Xcode的编译警告窗口中看到:spa

在开发中,咱们苦逼程序员的思惟不断的被打断,不断的来回切换。好比业务逻辑未定,网络请求地址切换,写死代码进行本地测试,项目联调等操做。最蛋疼的时项目上线后忽然发现请求地址不对,本地含有写死的测试数据或者咱们须要用到其余项目模块代码时,临时改动了别人代码,但木有改回去。这种状况就属于重大项目事故了。一两个不肯定改动,苦逼程序员或许会记住,可是多了以后,那直接是百分之一万会被遗漏的。因此最好的方法是在你不肯定的业务,测试数据等地方标上编译警告。以#waring 开头写下缘由,标记人,时间等说明信息。这样在项目开发结束后,会有一个专门的时间去消除这些警告,以确保没有遗漏的地方。代码规范

  对于依然喜欢用TODO,FIXME,XXX的开发者来讲能够,设置下工程的"Build Phases",而后添加New Run Script Build Phase,添加如下代码code

KEYWORDS="TODO:|FIXME:|XXX:"
find "${SRCROOT}" \( -name "*.h" -or -name "*.m" \) -print0 | xargs -0 egrep --with-filename --line-number --only-matching "($KEYWORDS).*\$" | perl -p -e "s/($KEYWORDS)/ warning: \$1/"

这样xocde就能够将这些特殊标记以#waring的形式展示出来。blog

相关文章
相关标签/搜索