iOS xcode11注释之总结

骑猪看日落 2022-12-30 13:42 143阅读 0赞

在开发中,我们经常使用快捷键 option + 鼠标点击某个关键字或方法,查看相应的文档信息，如图所示：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NtaWxlS0g_size_16_color_FFFFFF_t_70]  
一、单行注释

///单行注释
    -(void)singleLineComments{
        //注释和反注释的快捷键都是“command + /”，即“⌘ + /”。（如果是 Windows 键盘则为“Win键 + /”）
    }

二、多行注释，值得注意的是使用方法，先把你所写的方法写好，再添加注释快捷键就得到这个效果，其实@param oneStr这些是直接生成的，如图所示：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NtaWxlS0g_size_16_color_FFFFFF_t_70 1]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NtaWxlS0g_size_16_color_FFFFFF_t_70 2]

三、段落注释

/**
     - note ：一些记录
     */
    -(void)paragraphAmmotation{
        //段落注释暂时没有找到快捷键，但是可以添加一个代码块来代替
    }

四、如何查看注释

///查看注释
    -(void)seeAmmotation{
        //按下“Option + 左键”，即“⌥ + 左键”（如果是 Windows 键盘则为“ALT + 左键”），就能看到该函数的注释信息。
    }

五、注释关键字

///注释关键字
    -(void)commentKeywords{
        /**
         
         - Precondition: 算法前置条件
         - postcondition: 算法后置条件
         - requires: 算法内容
         - invariant: 循环不变量
         - complexity: O(n^n)算法复杂度
         - important: 一些重要信息描述
         - warning: 警告
         - attention: 警告信息
         - note: 一些记录
         - remark: 一些评论
         */
    }

如果帮助到你，就点赞吧！

END.

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NtaWxlS0g_size_16_color_FFFFFF_t_70]: /images/20221120/f468b326bc724b2aa81364d282b87535.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NtaWxlS0g_size_16_color_FFFFFF_t_70 1]: /images/20221120/d3b9961187c04a829047f18434524eb0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NtaWxlS0g_size_16_color_FFFFFF_t_70 2]: /images/20221120/4f8a92102e964514bfb3553fe7447b90.png