swift项目使用jazzy生成项目文档

第一步:

jazzy安装:

打开命令终端，输入: gem install jazzy

提示:

如果终端提示Error如下是因为没有权限在上面指令前加上'sudo'即:"sudo gem install jazzy":
ERROR:  While executing gem ... (Errno::EACCES)
    Permission denied @ dir_s_mkdir - /usr/local/lib/ruby/gems/2.3.0/extensions/x86_64-darwin-15/2.3.0/redcarpet-3.4.0

第二步:

jazzy使用:

①cd到项目根目录:

cd /Users/****/Desktop/根目录

和xcodeproj同一级的这一层

②执行:

jazzy --min-acl internal

image.png

项目中自动生成了docs文件夹,index.html就是你的文档

docs

文档

代码里的注释可以在文档的折叠里查看