IOS代码注释小结

代码注释的必要性:

想想看,半年之前代码,如果没有注释,是什么结果,擦,谁写的,写的啥?。。。好像是我写的。。

  • 减少同事之间的沟通成本
  • 快速恢复代码记忆
  • 快速生成文档
注释的形式
形式A:
/// Single line comment.

/// Single line comment spreading
/// over multiple lines.

形式B:
/** Single line comment. */

/** Single line comment spreading
 * over multiple lines.
 */

形式C:
/** Single line comment spreading
 over multiple lines. No star.
 */

形式D:
/*! Single line comment. */

/*! Single line comment spreading
 over multiple lines.
 */

详情见:
http://www.cnblogs.com/zyl910/archive/2013/06/07/objcdoc.html

Xcode注释插件
https://github.com/onevcat/VVDocumenter-Xcode

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值