Objective-C对方法进行注释的方法

名字看着挺绕的哈，其实就是对某个自己创建的方法进行注释，类似编写java代码时的注释javadoc一样，可以自动形成规范性的方法说明。

我们对方法进行注释时，最需要说明的就是方法的作用、方法的参数以及方法返回的结果，所以这里也只说这三个标签，其实很简单，如下所示：

/**
 * @brief 通过两个参数请求一个结果.
 *
 * @param valueOne 第一个参数.
 * @param valueTwo 第二个参数.
 *
 * @return 返回结果.
 */
- (NSString *)askForSomething:(NSString *)valueOne and:(NSString *)valueTwo;

我们声明方法时，紧挨着方法名在其上方输入上述的注释。brief表示方法的介绍，param表示参数，如果有多个就多次使用标签，这样在显示时也会显示的更好看，return表示返回的结果。其实也可以不写任何标签，那样也能显示，但是就是简单的文字，没有格式了。

现在我们调用方法，然后在调用的地方对着方法名，按住option键，也就是alt键，再点击方法名，就会弹出方法的说明，这时就可以看到我们注释的效果了：

这样是不是很清晰明了。虽然在声明方法时会做很多额外的工作，但是当代码量大了以后，这样做的效果就出来了，免得总是忘记各个方法是做什么的，参数又是什么，毕竟不能总是依靠起名嘛。

上面也说了，也有简易版的注释方式，如下：

/**
 * 通过两个参数请求一个结果.valueOne表示第一个参数.valueTwo表示第二个参数.方法会返回一个结果.
 */
- (NSString *)askForSomething:(NSString *)valueOne and:(NSString *)valueTwo;

效果如下：

这样呢其实也能达到说明方法作用的效果，属于懒人模式，但依然比直接打两个斜杠要靠谱，不过当参数多或者说明冗长的时候就比较难以直观地理解了，看各人的选取吧。