简化实施文件中的文档

Question

我在接口文件中记录我的方法，如下所示：

/**
 Returns an foo object containing a new bar value.

 @param newBar The bar value for the new foo. (Possible values: foo or bar)

 @return A foo object containing a calculated value.

 You can specify bar values in the following formats `bar`, `foo`.

 */

当我点击带有alt的方法名称时，Xcode会生成一个漂亮的小弹出窗口。

要为我的私有方法完成此操作，我在.m文件的顶部添加了@interface。我在其中声明并记录了我的方法。这是有效的，但它a）将我的文档与方法的实际实现分开，并且b）在快速跳转菜单（代码窗格上方）被混乱，因为我所有记录的方法出现两次（一次来自@interface用斜体表示，一次用@implementation表示。

有更好的方法吗？如果我在@implementation Xcode中记录方法似乎没有生成弹出信息。

Answer 1

如果您的课程为TheInterface，则可以使用其他标题，该标题可以为TheInferface-Private.h。

在此新标头上定义并记录您的私有方法和属性。文档按预期工作，您将在跳转栏中获得混乱。

它无法解决与实施问题分离的文档。我不明白为什么这是一个问题，每个人都希望文档在头文件中。

在一个单独的头文件中有一些私有方法很有用，有时候是在hackish子类中。