documentation de la méthode Swift - ne pas montrer dans autocomplete

Question

Je documente mes méthodes Swift comme suit:

/// Extracts the server time from the API call response. 
/// - parameter response: The HTTPURLResponse from which to extract the date. 
/// - returns: The 'Date' header from the response, as a `Date` object. 
/// - throws: If the 'Date' header is not found, or cannot be parsed to a `Date` object. 
static func extractServerTimeFromResponse(_ response: HTTPURLResponse) throws -> Date { 
    guard let serverTimeString = response.allHeaderFields["Date"] as? String else { 
     throw RGOTimeSyncHelperError.invalidServerResponse 
    } 
    let formatter = DateFormatter() 
    formatter.dateFormat = "EEE, dd MMM yyyy HH:mm:ss zzz" 
    guard let serverTime = formatter.date(from: serverTimeString) else { 
     throw RGOTimeSyncHelperError.dateParsingError 
    } 
    return serverTime 
} 

/// Calculates the offset of the local time compared to the server time. 
/// - parameter serverTime: The time from the server. 
/// - returns: The amount of seconds that need to be added to the client time, to match the server time. 
static func calculateOffset(serverTime: Date) -> Int { 
    let localTime = Date() 
    let offset = Calendar.current.dateComponents([.second], from: localTime, to: serverTime).second! 
    return offset 
} 

/// Add an offset in seconds to a given date. 
/// - parameter date: The date to which to offset should be applied. 
/// - parameter bySeconds: The offset, in seconds, that will be applied to the given date. 
/// - returns: A new `Date` object, comprised of the given date, with the given offset applied. 
static func offset(date: Date, bySeconds offset: Int) -> Date { 
    let offsetDate = Calendar.current.date(byAdding: .second, value: offset, to: date)! 
    return offsetDate 

} 

Quand j'alt-clic sur la signature de la méthode partout, Xcode montre le panneau de quickhelp les informations que je suis entré montré correctement.

Cependant, quand je commence à taper la signature de méthode et autocomplete saute vers le haut, il ne montre pas ces informations au bas de la zone de saisie semi-automatique comme pour les API d'Apple.

Où dans ma syntaxe commentaire vais-je tort?

Answer 1

La raison est que Xcode analyse la documentation affichée dans le survol à partir d'un ensemble de doc séparé et non à partir des fichiers de classe eux-mêmes.

Jetez un oeil ici: https://stackoverflow.com/a/43982094/1415898 pour une réponse plus complète.