doc - ShenYj/ShenYj.github.io GitHub Wiki

Swift 文档注释Tips

外部链接

当注释需要引入外部链接时,可以使用Markdown的方式来实现快速跳转

/// 跳转高德地图导航
///
/// - SeeAlso: [iOS URI 调用说明](https://lbs.amap.com/api/amap-mobile/guide/ios/ios-uri-information/)
/// - SeeAlso: [路线规划](https://lbs.amap.com/api/amap-mobile/guide/ios/route)
/// - SeeAlso: [导航](https://lbs.amap.com/api/amap-mobile/guide/ios/navi)
///
///  高德起点坐标非必填
///
func navigation(byAMap source: CLLocationCoordinate2D? = nil, destination: CLLocationCoordinate2D, destinationShowAddress: String)

效果图:

参照关联

比如当前注释需要跳转到其他类型上进一步了解时,可以使用Tag的形式建立关联,类似于外部链接

/// 景区模型
/// - Tag: ScenicArea
public struct ScenicArea { 
    ...
}

public struct RecentlyUpdatedScenicArea {
    /// - seeAlso: [ScenicArea](x-source-tag://ScenicArea)
    var showType: Int = 0
    ...
}

比如这个实例中,RecentlyUpdatedScenicArea 这个结构体中的showType属性的说明,需要查看另外一个模型 ScenicArea 中去进一步了解

  1. ScenicArea中增加一个Tag 格式为: - Tag: tag的名称, 注意Tag的T要大写
  2. 在需要关联的位置上添加格式: [参考目标名称](x-source-tag://tag名称)

效果图:

⚠️ **GitHub.com Fallback** ⚠️