appledoc自动生成技术文档

安装appledoc

执行如下命令

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

安装成功有如下提示

** INSTALL SUCCEEDED **

生成文档

话不多说,直接上图


appledoc自动生成文档命令解释.png

其中最后一个参数可脱离原工程的意思是,可以直接将一个工程里的几个文件单拿出来,放到一个文件夹里,传入这个文件夹的路径。我们可以实操一遍。
比如我们这里有个工程 testdoc, 创建testdoc1,testdoc2,testdoc3(其中testdoc1引用了testdoc2,testdoc2引用了testdoc3,这里不截图了)

WX20220215-172600@2x.png

WX20220215-172627@2x.png

然后我们把这三个的testdoc的.h文件复制出来放到一个文件夹里,


WX20220215-174536@2x.png

终端cd进入这个文件夹,输入如下命令:

appledoc --no-create-docset --output ~/Desktop/test1234  --project-name "testdoc" --company-id "testdoc"  --project-company "testdoc" ~/Desktop/test1234

生成一个html文件夹

WX20220215-175702@2x.png

打开里边的index.html

WX20220215-180017@2x.png

大功告成

ps:好多文章都说需要创建aggregate,还要写脚本,其实根本不用,只要一行命令,把相关的设置设置好就行了。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容