2018-10-16 09:12:46 RollingPin 阅读数 366
  • iOS/Swift/OC/Objective-C/Xcode/0基础/入门

    这是一门快速入门iOS开发的课程,目的是让大家快速学会,iOS开发环境搭建,和iOS一些基础知识,最后完成一个小项目。 项目信息 提供完整的Git提交历史,和每节视频一一对应,目前有41次提交,355行注释,271行代码(不包含可视化布局文件,纯Swift和Objective-C代码)。

    2908 人正在学习 去看看 任苹蜻

1.单行注释

1.1 简单注释

常用于 ==> 说明代码块中某段或某句的含义
用法 ==> 单独一行或者在某行代码的尾部
command + / 键 快捷注释某段代码

//注释文字
1.2 pragma mark

常用于 ==> 添加在代码行中便于从Xcode顶部地址栏中查找

#pragma mark 注释文字

2.多行注释

添加此注释后就会在写此方法的智能提示中显示此方法说明

2.1 简单注释

常用于 ==> 说明某个属性或者说明某个类的详情,也可注释某段代码
用法 ==>> 可书写多行
command + option + / 键 快捷注释某段代码

/**
  注释文字
  */
2.2 方法注释

常用于 ==> 说明某个方法
用法 ==>> 可分行书写多个参数信息
command + option + / 键 Xcode可智能列出注释参数

/**
此处可添加方法注释文字
@param first  注释此参数first
@param second 注释此参数second
@return 注释此方法返回参数
*/
- (NSString *)getResultWithParamFirst:(NSString *)first withParamSecond:(NSString *)second{

}

###附录:注释标记大全
添加下面参数 在Xcode中 option键+点击函数会调出详细注释,方便阅读代码

/** 
* @brief 简要描述 
* @author 标明开发该类模块的作者 
* @discussion 用途,方法
* @abstract   简介,概念
* @header  文件名
* @version 标明该类模块的版本 
* @see 参考转向,相关主题 
* @param 相关参数的说明 
* @return 对方法返回值的说明 
* @exception 对方法可能跑出的异常进行说明 
* @throw 抛出的异常 
* @since 从哪个版本此方法可以使用 
* @deprecated 弃用此API,从哪个版本开始 
* @serial (or @serialField or @serialData) 
* @link 链接相关方法 
* @copyright  版权
* /
参考网上帖子整理
2015-03-18 12:33:07 tubiebutu 阅读数 484
  • iOS/Swift/OC/Objective-C/Xcode/0基础/入门

    这是一门快速入门iOS开发的课程,目的是让大家快速学会,iOS开发环境搭建,和iOS一些基础知识,最后完成一个小项目。 项目信息 提供完整的Git提交历史,和每节视频一一对应,目前有41次提交,355行注释,271行代码(不包含可视化布局文件,纯Swift和Objective-C代码)。

    2908 人正在学习 去看看 任苹蜻

Xcode代码注释工具vvDocumenter


下载插件地址:https://github.com/onevcat/VVDocumenter-Xcode


安装:运行下载的vvDocumenter工程,重启Xcode

使用:方法前面///,自动完成框架,修改对应说明


2016-05-02 09:48:03 feizhuji 阅读数 491
  • iOS/Swift/OC/Objective-C/Xcode/0基础/入门

    这是一门快速入门iOS开发的课程,目的是让大家快速学会,iOS开发环境搭建,和iOS一些基础知识,最后完成一个小项目。 项目信息 提供完整的Git提交历史,和每节视频一一对应,目前有41次提交,355行注释,271行代码(不包含可视化布局文件,纯Swift和Objective-C代码)。

    2908 人正在学习 去看看 任苹蜻

最常见的三种注释方式:
第一种:/* 内容 */
第二种://内容
第三种:#pragma mark 内容 //会在编辑器导航栏生成如下图(图1)有助于查找
这里写图片描述
其他编辑器系统默认方式(效果如图2):
1.// !!!: 内容
2.// ???: 内容
3.// TODO:内容
4.// FIXME:内容
这里写图片描述
设置自己的注释标示:
进入项目-属性设置那个页面
选择一个Target
选择Build Phases标签
点击右下角的Add Build Phase
选择Run Script Psase,
展看上面刚出现那一栏Run Script,输入以下内容(如图3)

KEYWORDS="TODO:|FIXME:|\?\?\?:|\!\!\!:"
 find "${SRCROOT}" -name "*.h" -or -name "*.m" -print0 | xargs -0 egrep --with-filename --line-number --only-matching "($KEYWORDS).*\$" | perl -p -e "s/($KEYWORDS)/ warning: \$1/"

这里写图片描述

2016-04-28 11:25:57 r913218338 阅读数 165
  • iOS/Swift/OC/Objective-C/Xcode/0基础/入门

    这是一门快速入门iOS开发的课程,目的是让大家快速学会,iOS开发环境搭建,和iOS一些基础知识,最后完成一个小项目。 项目信息 提供完整的Git提交历史,和每节视频一一对应,目前有41次提交,355行注释,271行代码(不包含可视化布局文件,纯Swift和Objective-C代码)。

    2908 人正在学习 去看看 任苹蜻

在iOS下有多中注释的方法 可以方便我们查看代码,通用的//和/**/这里就不多说了

OC

#pragma mark - AFHTTPRequestOperation


swift

// TODO: add


// FIXME: BUG


// MARK: - 



也可以 把//TODO: 和//FIXME: 加上警告 如下面操作 不过个人没这个习惯


TAGS="TODO:|FIXME:"
echo "searching ${SRCROOT} for ${TAGS}"
find "${SRCROOT}" \( -name "*.swift" \) -print0 | xargs -0 egrep --with-filename --line-number --only-matching "($TAGS).*\$" | perl -p -e "s/($TAGS)/ warning: \$1/"



2015-04-23 16:48:52 Winzlee 阅读数 2145
  • iOS/Swift/OC/Objective-C/Xcode/0基础/入门

    这是一门快速入门iOS开发的课程,目的是让大家快速学会,iOS开发环境搭建,和iOS一些基础知识,最后完成一个小项目。 项目信息 提供完整的Git提交历史,和每节视频一一对应,目前有41次提交,355行注释,271行代码(不包含可视化布局文件,纯Swift和Objective-C代码)。

    2908 人正在学习 去看看 任苹蜻

虽然ObjC代码因为其可读性极强,而不太需要时常查阅文档,但是其实对于大多数人(包括我自己)来说,可能为方法或变量取一个好名字并不是那么简单的事情。这时候可能就需要文档或者注释来帮助之后的开发者(包括大家自己)尽快熟悉和方便修改。

我在开发和学习的过程中看到有人使用///就能在一个方法前面快速生成规范的Javadoc格式文档注释,所以上网查了查才知道原来是使用了插件的原因,仔细查询了下VVDocumenter Xcode这个插件效果还是很不错的,可以用///来快速生成文档注释(我之前看到的人用的是什么我就不得而知了),作者在GitHub上上传了该插件,

GitHub链接:  https://github.com/onevcat/VVDocumenter-Xcode

另外也可以在csdn下载

csdn下载地址:http://download.csdn.net/detail/winzlee/8626171


至于这插件如何用,当然也是很简单的,只需要解压之后直接点击,用Xcode 打开,直接run,run成功之后再重启Xcode 即可,最后打开自己的项目就可以在方法前输入///来快速生成方法注释了。我的是xcode6.2,可以运行。


这原理就是xcode有一个自己的插件库,当在xcode中run这个插件的时候xcode就会检测到这个插件,并把这个插件加入到自己的插件库中,重启xcode后就能在别的程序中运行此插件了。


效果图:



这原理就是xcode有一个自己的插件库,当在xcode中run这个插件的时候xcode就会检测到这个插件,并把这个插件加入到自己的插件库中,重启xcode后就能在别的程序中运行此插件了。

iOS 代码注释规范

阅读数 2075

iOS常用的注释方法

阅读数 2664

iOS 注释

阅读数 275

iOS 注释

博文 来自: weixin_35755389
没有更多推荐了,返回首页