<分区>
我在 Swift 中有一个枚举:
enum DateFormat{
case ShortDateFormat //7/28/2014 ShortStyle
case LongDateFormat //July 28, 2014 LongStyle
case LongFormatWithDay //Monday, July 28, 2014 FullStyle
case CurrentDayThreeLetters //Mon
}
而且我希望将其记录为类似于 C# 中智能感知的工作方式，在我键入 DateFormat.ShortDateFormat 的那一刻，弹出窗口将告诉我这会产生 7/28/2014。
我还想使用我编写的难以记住的函数来执行此操作，这些函数返回特定的内容以使我更容易，这样我就不必返回文件并确切地查找它做了什么(请注意，并不是说我有很多这些功能)!
我怎么能做这样的事？
最佳答案
HeaderDoc 标签适用于 Objective-C 和 Swift，尽管在 Swift 中，格式略有不同。在 Objective - C 中，记录方法的正确格式是这样的:
/*!
* @discussion This is an example discussion.
* @param bar - This is an example of a parameter.
* @return An example for a return type
*/
-(id)foo:(bar)foobar;
alt-click foo: 的结果是这样的
在 swift 中，文档的方式有点不同:
/**
This is an example discussion
:param: bar This is an example parameter.
:returns: This is an example return type.
*/
func foo(foobar: AnyObject) -> AnyObject {...}
这给出了与上面的 alt-clicking 相同的例子。
对于枚举，其原理与上面使用/** */ 格式的相同，但也使用/// 来描述单个枚举。
/**
Example enum description
- First: First example
- Second: Second example
- Third: Third example
- Fourth: Fourth example
*/
enum Example {
///First example
case First
///Second example
case Second
///Third example
case Third
///Fourth example
case Fourth
}
结果是一个格式整齐的项目符号列表:
当按住 alt 并单击其中一个实际案例时:
.
您将使用自动完成功能获得所需的效果，如下所示:
关于ios - Xcode 6 中的文档方法和枚举，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/25006366/