Question

我目前正在学习Objective-C，需要知道如何编写方法描述。在Objective-C中学习如何做到这一点我遇到了很多困难。

在Jave，我们有这个

/**
< h2 >MethodName</ h2 >
< p >Various Description, can use html with images etc.</ p >
*/
private void methodName(args[]..)
{

}

在objective-c中，我在哪里放置说明？这也是在头文件或实现文件中吗？

//Within Implementation?
- (float)gteHeightPercentage:(float)percentageToGet
{
    return self.view.bounds.size.height * percentageToGet;
}

//Within Header?
- (float)getWidthPercentage:(float)percentageToGet;

Answer 1

更新：以下格式适用于Objc。如果您想记录swift代码，请参阅NSHipster's blog about Swift Documentation

XCode 5可以做你想要的。感谢Wonil Kim，在 .h 文件中：

/** 
 * Add new message between source to destination timeline as empty name string
 * @author Wonil Kim
 *
 * @param sourceId Source timeline entity ID
 * @param destId Destination timeline entity ID
 * @return A newly created message instance
 */
- (ISMessage*)messageFromTimeline:(NSInteger)sourceId toTimeline:(NSInteger)destId;

完成后，你可以 alt +点击方法名称，然后......瞧！

当然，正如您在Kim's blog上看到的，这不是唯一的方法：

/*! Some description of the method....
 * \returns  The result
 */

可替换地，

/// Some description to show up, done by:
/// @author  Olly Dixon

你明白了......

正如许多人已经提到的，Objective-C没有向您展示您的文档;事实上，java（javadoc，也许）都没有。这是你的IDE，在这种情况下，是不可破解的Xcode：）

UPDATE2： Complete list of "Special Commands" in comments。

更新3：如果您要通过///启用自动生成文档，请使用VVDocumenter-Xcode。

UPDATE4：：VVD文件管理器已集成到Xcode中：

使用快捷方式（⌥选项+⌘命令+ /）添加文档如果您使用的是Xcode 8或更高版本，请注释您的代码

Answer 2

您所描述的内容被称为“文档注释”或简称“文档注释”。

从版本4.6.3开始，Xcode不会在弹出窗口或其快速帮助检查器中显示您自己的文档注释。您必须将注释编译为“docset”以使Xcode显示它们。有工具可以做到这一点，但除了退出并重新启动之外，没有办法让Xcode重新加载docset，所以我不建议打扰。

Xcode 5（目前可用作OS X和iOS开发人员计划的付费成员的开发者预览版）确实显示您自己代码的文档注释;见“Quick Help” on the Developer Tools Features page。您必须在头文件中编写doc注释。您可以使用doxygen或headerdoc格式。

Answer 3

在objective-c中，我在哪里放置描述？

像gcc和llvm这样的Objective-C编译器并不关心如何记录代码。有几个不同的文档生成器，例如Doxygen和HeaderDoc，可以通过适当格式化的注释构建文档，通常在头文件中。此外，Xcode可以轻松跳转到代码中定义的符号定义，并且“快速帮助”检查员可以向您显示定义，两者都没有在代码中添加任何特殊注释。

Objective-C方法描述（doc评论）

3 个答案: