如何使用 appledoc 自动生成文档

安装 appledoc

• appledoc 是一个开源软件，托管在 GitHub上

• 在 Terminal 中，执行以下语句

 
    git clone git://github.com/tomaz/appledoc.git
    cd appledoc
    sudo sh install-appledoc.sh
    

文档注释的规则

• 在 Objective-C规范注释心得 这篇文章中介绍得很详细，按照里面介绍的规则在 Objective-C 语言项目中加入注释

自动生成文档

• 在 Terminal 中执行命令

    appledoc
    -o ./doc
    --project-name your_project_name
    --project-company your_project_company
    --company-id your_company_id
    .
    

• 更多 appledoc 指令，用appledoc --help 查询

查看生成后的文档

• 打开 ./doc 路径下的 docset-installed.txt 文件

• 根据里面的 Path 地址，找到生成的文件夹

  

• 右键Show Package Contents

  • Contents -> Resources -> Documents -> index.html
• Enjoy it!