Xcode 13使用DocC生成混编Framework的Objective-C与Swift完整文档问询

1. 确认 Objective-C 头文件的公开权限 #

• 需要生成文档的 Objective-C 头文件，需要在项目 Build Phases > Headers 栏中，放到 Public 分组下，不要放在 Project 或者 Private 分组，DocC 只会为公开的 Objective-C 符号生成文档。

2. 为 Objective-C 符号添加符合 DocC 规范的注释 #

DocC 默认不会拾取无注释的 Objective-C 符号，需要用 /// 或 /** */ 格式为类、属性、方法添加基础注释即可，你提供的 ObjcTemp.h 可修改为如下格式：

#import <Foundation/Foundation.h>

NS_ASSUME_NONNULL_BEGIN

/// 测试用 Objective-C 类
@interface ObjcTemp : NSObject

/// 存储整型数值的属性
@property int val;

/// 打印 Hello World 的方法
-(void)printHello;

@end

NS_ASSUME_NONNULL_END

3. 确认项目构建设置正确 #

• 打开项目的 Build Settings，先确认 Defines Module 配置项为 YES，混合开发的 Framework 必须开启模块支持，DocC 才能正确识别两种语言的符号。
• 搜索 Documentation 关键词，确认以下配置项状态正确：
  • Documentation Output Level：设置为 All Symbols，不要选择 Minimum 或 None
  • CLANG_ANALYZER_DOCUMENTATION：设置为 YES，开启 Clang 对 Objective-C 的文档解析支持
  • 如果需要常规编译时也同步生成文档，可开启 Build Documentation during 'Build' 选项
• 确认你构建文档时选择的运行目标，与项目支持的平台一致，避免符号被平台过滤。

4. 重新构建文档 #

配置修改完成后，选择 Xcode 顶部菜单的 Product > Build Documentation，等待构建完成即可同时看到 Swift 和 Objective-C 的符号文档。如果未正常展示可先清理 Xcode 缓存（按住 Option 键点击 Product > Clean Build Folder）后重新构建。

内容的提问来源于stack exchange，提问作者Nieb_Hasan_077