方法注释模板

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

/** 
 * [标题]
 *
 * [介绍]
 * [介绍]
 * [介绍]
 * @note 说明
 eg.
    <table>
    <tr><th>标题1</th><th>标题2</th><th>标题3</th></tr>
    <tr><td>text1</td><td>text2</td><td>text3</td></tr>
    </table>
 * @attention 注意事项
 * @param [参数] [参数说明]
 * @param [参数] [参数说明]
 * @return [返回值] [返回值说明]
 *
 * @see [相关内容]
 * @see [相关内容]
 */

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

- (void)test {
    //  MARK: 注释信息
    //  TODO: 提示信息
    //  FIXME: 提示修复
    //  !!!: 注意信息
    //  ???: 问题提示
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容