相关疑难解决方法(0)

我有一些关于Swift文档注释的问题.

1. 反正有没有像一些Apple文档那样制作一个相关的声明部分.例如,当我选择+单击tablewView(_:heightForRowAtIndexPath :)方法时,它会将我链接到生成的文档中的其他3个相关方法.

2. swift中有警告标签吗？我知道在objective-c中它允许你做@warning并在生成的文档中得到一个粗体警告.但是,:警告:在快速文档评论中没有任何作用,所以我很好奇是否还有其他方法.

3. 有没有办法让您的文档成为与Apple文档类似格式的HTML文件.我知道在其他IDE中用于其他语言,例如Eclipse,您只需为代码生成html文档.XCode有这个吗？

有没有一种标准的方法来编写Swift语言的文档注释？相当于javadoc(Java)或docstrings(Python)的东西？

例:

/**
 * My docstring example
 * @return the String "foo"
*/
func foo() -> String {
    return "Foo"
}

我在课堂上为我的方法添加了一些描述.这就是我实现这个目标的方法:

点击后看起来像这样......

如何使带下划线的方法可以点击？我希望它被引用,以便当用户点击它时,它们被定向到特定的网页以获取文档.

它甚至可能吗？在此先感谢,任何帮助将不胜感激

假设我有两个类:

/**
  This class should be used together with [Foo]( ??? ).
*/
class Bar {
    func doNothing() {}
}

/**
  Description of what Foo does goes here.
*/
class Foo {
    func doNothing() {}
}

我想在Bar的Xcode快速帮助中创建一个指向Foo或Foo快速帮助的链接.它甚至可能吗？如果是这样,怎么样？

[name](target)通过查看Apple的文档和Apple的更多文档,我可以看出链接的语法并不符合要求.

基本上，我正在编写一个程序，其中涉及大量的三角函数和数学运算，稍后必须对其进行审查。用文字解释这部分代码中发生的事情是很困难的。我想知道是否可以在代码的注释中添加图表以帮助简化解释？

谢谢！

如何将文本添加到自动完成，如下所示，“告诉元素激活自己......”部分，

这就是我所拥有的

但是“这是一个测试”部分没有出现在自动完成中，

请不要链接到其他涵盖如何撰写评论的帖子，以便它们显示在使用 Option+Click 弹出的窗口中，我很清楚如何做到这一点。我的问题特别是关于自动完成窗口中显示的评论。

我一直在使用Xcode 5的能力,用支持的注释语法记录我的代码(参见这个问题).Xcode 6使用Objective-C源支持它,遗憾的是没有使用Swift源.

我想在.swift源代码上执行内联文档.知道如何做或最佳做法？

提前致谢,

路易斯

我在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
 }

而且我希望这个记录类似于intellisense在C#中的工作方式,在我输入的那一刻DateFormat.ShortDateFormat,弹出窗口会告诉我这会产生7/28/2014.

我还想用我写的那些难以记忆的函数来做这件事,这些函数返回特定的东西以使我更容易,所以我不必回到文件并查看它究竟做了什么(不是我有这些功能很多,请注意)!

我怎么能做这样的事情？

我正在记录我公司的iOS应用程序的代码,现在我转向了具有完成处理程序的方法.是否有记录完成处理程序的特定方法,或者我应该将其作为参数的一部分？

例如:

/**
Description
- Parameters:
     - parameter1: description
     - parameter2: description
     - completion: description
*/

这是正确的方式还是有另一种更好的方法？或者它应该在文档的"返回"部分？

谢谢