ios – Xcode 6中的文档方法和枚举

enum DateFormat{
   case ShortDateFormat //7/28/2014 ShortStyle
   case LongDateFormat  //July 28,2014 LongStyle
   case LongFormatWithDay //Monday,July 28,2014 FullStyle
   case CurrentDayThreeLetters //Mon
 }

解决方法

/*!
 * @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单击时,这会给出相同的示例.

对于枚举,其原理与上面使用/ ** * /格式相同,但也使用///作为单独的枚举描述.

/**
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-click其中一个实际案例时：.

您将使用自动完成功能获得所需的效果,如下所示：