Эта статья отличная статья от Nate Cook и Mattt Thompson, которая описывает формат комментариев к документации в Swift.
Однако, поскольку Swift 2 в XCode 7 beta некоторые его части больше не работают. Например, :param:
и :returns:
не дают желаемого результата (они просто отображаются как-is вместо).
Другие части, похоже, продолжают работать (т.е. оба типа комментариев в стиле /// ...
или /** ... */
, кодовые блоки, списки), но не имеют возможности разметки документации в аналогичные разделы, такие как основной API,.
Кто-нибудь знает, есть ли способ выделить параметры метода и возвращенные результаты (что :param:
и :returns:
в прошлом) в комментариях к документации в Swift 2?