方法注释模板

随着代码越写越多，也越来越追求编码的规范化，其中就包括方法的注释，所以特意整理了一下方法注释的模板，仅供参考，也欢迎各位大神给以补充~~

/** 
 * [标题]
 *
 * [介绍]
 * [介绍]
 * [介绍]
 * @note 说明
 eg.
    

    
标题1
标题2
标题3
    
text1
text2
text3
    
 * @attention 注意事项
 * @param [参数] [参数说明]
 * @param [参数] [参数说明]
 * @return [返回值] [返回值说明]
 *
 * @see [相关内容]
 * @see [相关内容]
 */

另外，下面是常用到的方法中的，具有特殊标注的注释：

- (void)test {
    //  MARK: 注释信息
    //  TODO: 提示信息
    //  FIXME: 提示修复
    //  !!!: 注意信息
    //  ???: 问题提示
}