XCode 一键添加优美注释

最新推荐文章于 2020-02-19 08:37:38 发布

CJsen

最新推荐文章于 2020-02-19 08:37:38 发布

阅读量4k

点赞数

分类专栏： Iphone 应用开发

本文链接：https://blog.youkuaiyun.com/CJsen/article/details/9335917

版权

Iphone 应用开发专栏收录该内容

64 篇文章

订阅专栏

本文介绍了一种在Xcode中快速为函数、变量及枚举生成规范注释的方法。通过利用ThisService工具和Doxygen.rb文件设置快捷键，开发者能够高效地为代码添加清晰的注释。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

本站文章转载务必在明显处注明：原文链接:http://blog.youkuaiyun.com/cjsen/article/details/9335917

前言

为大家介绍一种方便添加注释的方法，使用的效果如下，

函数注释：

/**
 *	@brief	<#Description#>
 *
 *	@param 	application 	<#application description#>
 *	@param 	launchOptions 	<#launchOptions description#>
 *
 *	@return	<#return value description#>
 */
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{}

变量注释

/**
 *	@brief	<#Description#>
 */
@property (nonatomic, retain) UIWindow *window;

枚举注释：

/**
 *	@brief	<#Description#>
 */
enum istest {
	istest1 = 1, /**< <#istest1 description#> */
	istest2 = 2 /**< <#istest2 description#> */
};

这种可以设置快揵键的方式，自己生成注释格式（不过不会自定义）；下面说说如何设置

使用

一：需要用一个工具（ThisService），一个文件（Doxygen.rb）

用ThisService将Doxygen.rb文件注册成一个服务并设置快揵键即可

首先，解压运行 ThisService 工具，如下

选好Doxygen.rb文件，和Filter(both)（名字顺便取都行，记住就好）,点击 Create Service，这里就搞定了

二：设置快捷键

打开系统偏好设置-->键盘

进入键盘快捷键设置--》服务，找到刚刚创建的服务Doxygen设置如下图

注意：快捷键可以按自己的习惯设置，但不要和系统或Xcode中原有的快捷键重复

最后：我们就回到XCode就可以用了，不行重启一下Xcode就行。。

使用方法：找到你要注释的代码，全选后按自己刚刚设置的快捷键就可以生成上面优美的注释了

工具下载