美文网首页iOS Learning
Xcode 之注释和标记整理

Xcode 之注释和标记整理

作者: 刀鞘 | 来源:发表于2016-01-12 18:05 被阅读1344次

本文在这里整理了6种添加注释的方法和9种添加标记的方法。

注释


/*! 按钮1 */

@property(nonatomic,strong)UIButton * btn1;

/** 按钮2 */

@property(nonatomic,strong)UIButton * btn2;

/// 按钮3

@property(nonatomic,strong)UIButton * btn3;

@property(nonatomic,strong)UIButton * btn4;/**< 按钮4 */

//按钮5 (快捷键 cmd + /)

@property(nonatomic,strong)UIButton * btn5;

/* 按钮6 */

@property(nonatomic,strong)UIButton * btn6;

前面4种加了特效,可以显示出自己给属性、方法、成员变量等添加上去的描述。后面2种,则不可以。个人尤其喜欢第四种,可以方便的添加很简短的注释,无需换行,搭配一个御用code snippet的快捷键就更美了。

标记

1、6种主流标记

// MARK: ~~~~~~~~~~~~~~~~~~~~

// TODO: puti is not a tree

// FIXME: mirror is not a table

// !!!: it is empty at all here

// ???: why pm 2.5 is so high

#pragma mark - UITableViewDelegate (中间的 ‘-’ 号,可以添加一条分割线)

2、3种非主流标记

#warning >>>>>>>>>>>>>>

#error <<<<<<<<<<<<<<

Breakpoint

标记,虽然可以快速的让你找到对应的代码所在,但是,最好有始有终,有添加就有删除,在代码修改的时候,对应的标记要及时作对应的变动。而且每种标记的运用和表达的意思都要理清楚,切勿滥用。

剑本无错,对错在持剑之人。

最后,附上一段检测工程中部分标记的脚本。

KEYWORDS="TODO|FIXME|\?\?\?:|\!\!\!:"

find "${SRCROOT}" \( -name "*.h" -or -name "*.m" \) -and \( -path "${SRCROOT}/Pods/*" -prune -o -print0 \) | xargs -0 egrep --with-filename --line-number --only-matching "($KEYWORDS).*\$" | perl -p -e "s/($KEYWORDS)/ warning: \$1/"

相关文章

  • Xcode 之注释和标记整理

    本文在这里整理了6种添加注释的方法和9种添加标记的方法。 注释 /*! 按钮1 */ @property(nona...

  • Xcode注释标记

    代码如下: 效果图如下:

  • Xcode注释标记

  • PHP注释标记的整理

    什么是注释标记 我们在平常写代码或看别人写的代码时, 在方法的说明注释中经常会有这样的注释: 上面的@param ...

  • Xcode中的注释以及标记

    良好的编码规范是程序员必备的素质,编码中的代码注释尤为重要,健全的代码注释可以提高代码可读性和维护性,不仅为了标识...

  • Swift 注释技巧

    我的博客原文地址 Swift注释技巧 //单行注释 /* 多行注释 */ /// 标记注释方式1 /** 标记注释...

  • 跟我学Git(二)

    标记 Git可以把特定的历史版本标记为重要版本。 创建注释标签 -a表示标签为注释标签,-m指定标记信息,它会和标...

  • PHP 基础知识

    基本语法 PHP标记 注释 PHP 支持 C,C++ 和 Unix Shell 风格(Perl 风格)的注释。 类...

  • 解决xcode10文档注释无法使用问题

    1、关闭模拟器和xcode,到重命名xcode为xcode22、再重命名xcode2为xcode即可3、文档注释的...

  • java笔记

    3.2注释 最常用的方式为//当需要长篇注释时,可以在每行注释前面标记//,也可使用/*和 */将注释括起来当需要...

网友评论

本文标题:Xcode 之注释和标记整理

本文链接:https://www.haomeiwen.com/subject/qcfckttx.html