Xcode配置Appledoc并生成项目文档

本文介绍如何安装Appledoc文档生成工具,并详细说明了如何配置Xcode以使用Appledoc自动生成项目的文档。此外,还提供了具体的Shell脚本示例。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

安装Appledoc

首先说下Appledoc的地址 https://github.com/tomaz/appledoc 这里有Appledoc的最新信息。

安装Appledoc很简单

1
git clone git: //github .com /tomaz/appledoc .git

把该程序clone到本地,然后进入程序根目录。执行安装sh

1
sudo sh install -appledoc.sh

配置Xcode生成文档

  1. 创建一个项目HelloWorld。
  2. 点击项目设置然后添加Target如图
    1
  3. 弹出框选择Aggregate模板
    2
  4. 输入Target名称为Document
    3
  5. 添加Phase的类型为 Add Run Script
    4
  6. 拷贝官网的代码到Run Script中
    5

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    #appledoc Xcode script 
    # Start constants 
    company= "ACME"
    companyID= "com.ACME" ;
    companyURL= "http://ACME.com" ;
    target= "iphoneos" ;
    #target="macosx";
    outputPath= "~/help" ;
    # End constants
    /usr/local/bin/appledoc \
    --project-name "${PROJECT_NAME}" \
    --project-company "${company}" \
    --company- id "${companyID}" \
    --docset-atom-filename "${company}.atom" \
    --docset-feed-url "${companyURL}/${company}/%DOCSETATOMFILENAME" \
    --docset-package-url "${companyURL}/${company}/%DOCSETPACKAGEFILENAME" \
    --docset-fallback-url "${companyURL}/${company}" \
    --output "${outputPath}" \
    --publish-docset \
    --docset-platform-family "${target}" \
    --logformat xcode \
    --keep-intermediate-files \
    --no-repeat-first-par \
    --no-warn-invalid-crossref \
    -- exit -threshold 2 \
    "${PROJECT_DIR}"
  7. 在.m文件中写入自己的注释
    6
  8. 生成文档
    7
  9. 成功后查看生成的文档
    8
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值