本文在这里整理了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/"