Jazzy文档工具中隐藏继承方法的最佳实践

背景介绍

Jazzy是Swift语言的一个优秀文档生成工具，它能够自动为Swift代码生成美观的API文档。在实际开发中，我们经常会遇到类型继承或协议实现的情况，这会导致文档中显示大量继承而来的方法，而这些方法可能并不是我们想要重点展示的内容。

问题描述

当Swift类型继承自某个类或实现某个协议时，Jazzy默认会将这些继承的方法也包含在生成的文档中。例如，一个类实现了Equatable和Hashable协议，文档中会自动包含==运算符、hash(into:)方法等协议要求的方法。这可能会使文档显得冗长，分散用户对核心API的注意力。

解决方案

目前Jazzy提供了几种方式来控制文档中继承方法的显示：

1. 使用:nodoc:标记：这是最直接的方式，可以在不希望出现在文档中的方法前添加此标记。例如：

/// :nodoc:
public static func == (lhs: MyType, rhs: MyType) -> Bool {
    // 实现代码
}

2. 使用@_documentation(visibility:)属性：这是Swift的一个隐藏特性，可以更精细地控制文档的可见性。例如：

@_documentation(visibility: private)
public func hash(into hasher: inout Hasher) {
    // 实现代码
}

技术考量

虽然目前Jazzy没有提供全局配置来隐藏所有继承方法，但上述两种方法已经能够满足大多数场景的需求。开发者需要权衡文档的完整性和简洁性：

• 如果继承方法有特殊实现或需要特别说明，应该保留文档
• 如果继承方法是标准实现且无特殊之处，可以考虑隐藏以保持文档简洁

未来展望

根据Jazzy的issue讨论，未来版本可能会增加更智能的继承方法处理机制，比如自动识别纯继承方法（未重写）并提供全局配置选项。这将使文档生成更加灵活和符合开发者预期。

最佳实践建议

1. 对于协议实现的方法，如果实现是标准或简单的，建议隐藏文档
2. 对于重写父类方法且有重要行为变更的，应该保留并补充详细文档
3. 保持文档一致性，要么全部隐藏标准实现，要么全部显示并补充说明

通过合理使用这些文档控制功能，开发者可以生成更加专业和易读的API文档，提升代码的可维护性和使用体验。