注释的几种写法

2019独角兽企业重金招聘Python工程师标准>>>

单行注释

// comment

用command + /  可以快速进行注释和取消注释

 /**< comment    */

这种注释比较紧凑，适用于枚举类型的注释 

enum  WXErrCode {

    WXSuccess           = 0,    /**< 成功    */

    WXErrCodeCommon     = -1,   /**< 普通错误类型    */

    WXErrCodeUserCancel = -2,   /**< 用户点击取消并返回    */

    WXErrCodeSentFail   = -3,   /**< 发送失败    */

    WXErrCodeAuthDeny   = -4,   /**< 授权失败    */

    WXErrCodeUnsupport  = -5,   /**< 微信不支持    */

};

多行注释

/**

 *  comment

 */

其他技巧

可以用代码折叠对多行注释进行折叠

command ＋alt + 左箭头    折叠

command + alt + 右箭头  展开折叠

折叠前

折叠后

帮助编写注释的开源项目 vvdocumenter只需要输入///就可以完成多行注释

#pragma mark - WXApiDelegate

转载于:https://my.oschina.net/u/2360054/blog/614712