← Каталог
Справочник по языку Swift — 3. Документирование кода
Фрагмент из «Справочник по языку Swift»: 3. Документирование кода.
/// Загружает пользователя по идентификатору.
///
/// Эта функция выполняет сетевой запрос к API и возвращает объект `User`.
/// При ошибке сети или недопустимом ответе выбрасывается `NetworkError`.
///
/// - Parameters:
/// - id: Уникальный идентификатор пользователя. Должен быть положительным.
/// - Returns: Объект `User`, содержащий данные профиля.
/// - Throws: `NetworkError.invalidID`, если `id <= 0`.
///
/// - Important: Вызов этой функции требует активного интернет-соединения.
public func fetchUser(id: Int) throws -> User {
// ...
} /// Загружает пользователя по идентификатору.
///
/// Эта функция выполняет сетевой запрос к API и возвращает объект `User`.
/// При ошибке сети или недопустимом ответе выбрасывается `NetworkError`.
///
/// - Parameters:
/// - id: Уникальный идентификатор пользователя. Должен быть положительным.
/// - Returns: Объект `User`, содержащий данные профиля.
/// - Throws: `NetworkError.invalidID`, если `id <= 0`.
///
/// - Important: Вызов этой функции требует активного интернет-соединения.
public func fetchUser(id: Int) throws -> User {
// ...
}