代码注释的必要性:
想想看,半年之前代码,如果没有注释,是什么结果,擦,谁写的,写的啥?。。。好像是我写的。。
- 减少同事之间的沟通成本
- 快速恢复代码记忆
- 快速生成文档
注释的形式
形式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