IOS代码注释小结

素颜马尾好姑娘i 2022-08-05 04:26 166阅读 0赞

#### 代码注释的必要性： ####

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

>  *  减少同事之间的沟通成本
>  *  快速恢复代码记忆
>  *  快速生成文档

#### 注释的形式 ####

形式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][http_www.cnblogs.com_zyl910_archive_2013_06_07_objcdoc.html]

Xcode注释插件  
[https://github.com/onevcat/VVDocumenter-Xcode][https_github.com_onevcat_VVDocumenter-Xcode]

[http_www.cnblogs.com_zyl910_archive_2013_06_07_objcdoc.html]: http://www.cnblogs.com/zyl910/archive/2013/06/07/objcdoc.html
[https_github.com_onevcat_VVDocumenter-Xcode]: https://github.com/onevcat/VVDocumenter-Xcode

发表评论取消回复

表情：

评论列表（有 0 条评论，166人围观）

还没有评论，来说两句吧...

相关阅读

相关 hbuildx自动添加作者和创建时间注释_iOS 注释方法大全代码块加快捷键注释

注释规范良好的编码规范是程序员必备的素质，编码中的代码注释尤为重要，健全的代码注释可以提高代码可读性和维护性，不仅为了标识此块代码的含义，很多时候包含了对业务逻辑的解释

梦里梦外;/ 2023年01月01日 10:59/ 0 赞/ 230 阅读

相关 libplugin代码注释

使用到内核里的双向链表技术。 ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nL

ゝ一纸荒年。/ 2022年12月02日 00:44/ 0 赞/ 100 阅读

相关 Python 代码注释

注释的作用 > 用自己熟悉的语言，在程序中对某些代码进行标注说明，增强程序的可读性。单行注释以 `` 开头，`` 右边的所有东西都被当做说明文

àì夳堔傛蜴生んèń/ 2022年10月18日 01:55/ 0 赞/ 160 阅读

相关 commons-io 小结

commons-io 小结 Maven依赖： <dependency> <groupId>commons-io</groupId>

阳光穿透心脏的1/2处/ 2022年09月09日 06:06/ 0 赞/ 110 阅读

相关 IOS代码注释小结

代码注释的必要性：想想看，半年之前代码，如果没有注释，是什么结果，擦，谁写的，写的啥？。。。好像是我写的。。 > 减少同事之间的沟通成本 > 快速恢复代码

素颜马尾好姑娘i/ 2022年08月05日 04:26/ 0 赞/ 167 阅读

相关 JAVA文档注释小结

JAVA文档注释小结目录 1 常用Java注释标签（Java comment tags） @author 作者 @param 输入参数的名称说明 @

梦里梦外;/ 2022年07月21日 02:18/ 0 赞/ 153 阅读

相关 Java IO流小结

1 java.io.File类的使用 java.io.File类：文件和目录路径名的抽象表示形式，与平台无关 File 能新建、删除、重命名文件和目录，但 File 不

小鱼儿/ 2022年03月17日 19:14/ 0 赞/ 135 阅读

相关代码规范小结

现在学习VB已经有一段时间了，对敲代码有了新的感触，一直想要整理一下。尤其是经过了作品展,感觉对代码规范的书写有了更大的体会,你敲出的东西,对他人有多少价值

柔情只为你懂/ 2022年01月22日 20:30/ 0 赞/ 155 阅读

相关代码注释符

1. HTML  2. JavaScript 单行： //document.getEleme

心已赠人/ 2021年11月05日 01:56/ 0 赞/ 327 阅读

相关 Java代码注释

曾经我对“一份好的代码里注释至少要占到一半的份量”这样话深信不疑，我也不厌其烦的给每一个函数都加上javadoc，对此，我深感自豪；而对于别人写代码不加注释的“坏习惯”，我深表

骑猪看日落/ 2021年05月10日 11:18/ 0 赞/ 616 阅读