注释规范

总体规则：尽量让代码可以自表述，而不是依赖注释。

1、合理的注释。好的注释不仅能让人轻松读懂你的程序，还能提升代码的规格。注释是为了让别人看懂代码，也是让你自己看懂代码。

2、注释内容条例。

（1）所有的property均需要注释；

（2）所有自定义的方法需要注释；

（3）复杂的代码片段需要加以注释。

3、类或文件的良好注释通常包涵：类文件名、项目名、作者信息、创建日期、版权信息、类文件包含的内容及作用。

比如：

    //
    // SPUser.h
    // IPostService
    // Created by XXX on 15/21/06.
    // Copyright 2015 ChinaPost Inc All rights reserved.
    //
    // 用户信息类，处理用户数据
    //

4、方法或函数的良好注释通常包涵：代码的作用、参数、返回值。（可使用VVDocumenter插件进行注释）

比如：

    /**
     * 获取城市列表数据
     * @param 无
     * @return 城市列表数据cityArray
     */