2017-10-10 117 views
0

人們用它來記錄他們的庫和框架是否有某種標準?相當於sdk的招搖呢?

理想情況下,它將使用JSON或YAML,並允許生成很好地呈現它的HTML頁面。

+0

相關:[?使用什麼工具來寫文檔(https://stackoverflow.com/ q/12537/113116),[存儲軟件文檔的最佳方式是什麼?](https://stackoverflow.com/q/99419/113116) – Helen

回答

1

SDK文檔最常見的方法是從源代碼中的註釋生成文檔。這樣,類/函數參考文檔可以很容易地與實現保持同步。

有不同編程語言和框架的文檔生成器。有些工具可以讓你用手寫的概念性主題結合產生的參考文檔(概述,「入門」,等等)

一些流行的工具有: