hbuildx自动添加作者和创建时间注释_iOS 注释方法大全代码块加快捷键注释

梦里梦外; 2023-01-01 10:59 276阅读 0赞

#### **注释规范** ####

良好的编码规范是程序员必备的素质，编码中的代码注释尤为重要，健全的代码注释可以提高代码可读性和维护性，不仅为了标识此块代码的含义，很多时候包含了对业务逻辑的解释，项目中难免有逻辑复杂之处，不加注释的代码，数日后自己看都会觉得陌生，更不要说其他人看了，今天分享一下Objective-C开发中常用的代码注释方式以及应用场合。

#### **注释形式** ####

> 注释形式主要有：
> 
> 单行注释，多行注释，方法注释，方法集注释(配合代码块实现快速注释)

1. 单行注释

使用 // 注释单行代码，最常见的使用场景是在方法内注释某个属性或某块区域的含义，如下图：

![18e41a92828d73aa87eab3f6976f610c.png][]

2. 多行注释

使用 /\*\* 文本 \*\*/ 的注释格式(快捷键cmd+alt+/)可以对属性和类以及方法进行注释，与//不同的是，该注释方式可以写多行，一般使用在类的头文件，多行介绍当前类的含义，如下图：

![5e7f00c9c4081aa2cdc2173ccc2ad4a5.png][]

3. 方法注释

与方法2相同，使用 /\*\* 文本 \*\*/ 的注释格式(快捷键cmd+alt+/)可以对方法进行注释，快捷键会根据方法参数自动生成需要填写的注释内容，并且在其他地方使用该方法时，Xcode会智能提示出之前写的注释内容，如下图：

在方法上方使用快捷键 cmd+alt+/：

![f96760aa3ae418e6686c8ad663d52d10.png][]

使用该方法时显示注释内容：

![191eb0bbaa51a0f265b519af64c32f0a.png][]

4：方法集注释(配合代码块实现快速注释)

先介绍一下，何为方法集注释，通常没有添加方法集的类是这样的：

![ddc8082e95150a66d9c10b8a0cfc42fb.png][]

为了快速定位类中的某块代码，或某个方法，Xcode为我们提供了方法集的注释方式，可大大减少搜寻目标代码的时间，如图：

![98eb2f0d95f20d9090b06ca9a5ddb9ad.png][]

这样就能对类中的方法和模块一览无余，要查找或修改的时候可以迅速定位，节省时间，提高自我体验。

实现方法：

( \#pragma mark   )

但是每次敲这些字符一定不是你想要的效果，在Xcode8之前可以使用VVDocumenter增强版(个人在原基础上修改添加方法集注释功能)，由于Xcode8默认禁用使用插件，所以我们采用代码块+快捷键的方式来实现，效果也是酸爽：

![11588d6d5f1ce643c1f75ce1f334733c.gif][]

![e0501a2b9ee802d861b18398a50ae2ae.png][]

上图中，就是我使用代码块+快捷键来实现的方法集注释，编写方便，快捷，具体实现步骤如下：

添加代码块并设置快捷键：

![3d35a0850168e3340b9dad05dc3c4c9b.png][]

这样就大功告成，保存代码块，在代码中使用预设的快捷键，编译器会自动提示，回车，输入即可。

记得代码块预设的时候“注释内容外要用” 。

![85537b0c598647a205188f9e26f4c5f1.gif][]

> 作者：\_小迷糊
> 
> 链接：https://www.jianshu.com/p/9e1e2ee5c679

> 本公众号转载内容已尽可能注明出处，如未能核实来源或转发内容图片有权利瑕疵的，请及时联系本公众号进行修改或删除【联系方式QQ : 3442093904  邮箱：support@cocoachina.com】。文章内容为作者独立观点，不代表本公众号立场。版权归原作者所有，如申请授权请联系作者，因文章侵权本公众号不承担任何法律及连带责任。

**---END---**

![8b9e7c57440f8d4041bc17940df7c88b.png][]

[18e41a92828d73aa87eab3f6976f610c.png]: /images/20221120/9a64fc3dc4a3415faf7bbbd45592256f.png
[5e7f00c9c4081aa2cdc2173ccc2ad4a5.png]: /images/20221120/c635c15bd0e5425d8ee382c6115be873.png
[f96760aa3ae418e6686c8ad663d52d10.png]: /images/20221120/87d5bf7afb7449759762cfaf7c475f44.png
[191eb0bbaa51a0f265b519af64c32f0a.png]: /images/20221120/9b73a81236c94adf88c5688dbb0ff363.png
[ddc8082e95150a66d9c10b8a0cfc42fb.png]: /images/20221120/e9b039132de2453dad2e4b8f825d381a.png
[98eb2f0d95f20d9090b06ca9a5ddb9ad.png]: /images/20221120/5d0c63732cb947379ef06a6066457a6b.png
[11588d6d5f1ce643c1f75ce1f334733c.gif]: /images/20221120/8be1cb0207ba4229b7fea506a7087bf6.png
[e0501a2b9ee802d861b18398a50ae2ae.png]: /images/20221120/5c1d80e7e32f4e9f81a24f69651c9b48.png
[3d35a0850168e3340b9dad05dc3c4c9b.png]: /images/20221120/fe2bb6b0b6df42e9bd13d6ebaae20a22.png
[85537b0c598647a205188f9e26f4c5f1.gif]: /images/20221120/31ca013095e644e79f0ae42ab4dfd2ba.png
[8b9e7c57440f8d4041bc17940df7c88b.png]: /images/20221120/591a88cd875c4f79acbe6070a7565b8c.png