您的位置：首页 > 移动开发 > IOS开发

IOS代码注释小结

2015-06-05 16:50 393 查看

代码注释的必要性：

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

减少同事之间的沟通成本

快速恢复代码记忆

快速生成文档

注释的形式

形式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
内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理 点击这里给我发消息
标签： 
相关文章推荐
新的分享
章节导航