ShowDoc可以扶植用戶編輯API文檔 ，文档讓用戶在編輯源代碼的编辑時候可以更好對代碼做標注，可以讓別人知道你編輯的工具 官代碼是什麽意思 ，適合專業的文档開發團隊使用 ，當你在編輯新軟件或者是编辑開發新項目的時候就可以將本軟件安裝到你的開發環境 ，在編輯代碼的工具 官萤火突击脚本跑图時候就可以及時編輯API ，方便其他用戶找到函數或者是文档調用類似的API；ShowDoc提供多種部署方式 ，可以選擇好動安裝 ，编辑可以選擇自動腳本安裝 ，工具 官詳細的文档安裝方式可以查校驗官方提供的教程 ！
軟件功能
1 、编辑ShowDoc提供更好的工具 官編輯方式 ，扶植用戶在設計API文檔的文档時候提供更方便的操作
2 、可以手動編輯API文檔 ，编辑可以從代碼裸露API文檔
3 、工具 官現在很多程序城市裸露API文檔
4 、通過查校驗API文檔就可以知道軟件開發的結構以及相關模塊的介紹
5、讓編程人員可以知道該項目詳細的編程方式
6、當你需要編輯API文檔的萤火突击透视辅助工具時候就可以選擇ShowDoc
7 、提供豐碩的編輯組件 ，擁穿著composer.json ，擁穿著.gitignore
8 、可以將所有編輯組件增補到你的開發環境
9 、可以在直接從你的代碼文件找到可以裸露為API文檔的內容
10 、提供verifyCode.php、jquery.zclip等多種調試組件
軟件特色
1 、API文檔在很多場合都可以使用，擁穿著對新開發項目裸露API文檔
2 、擁穿著對一些的比較繁雜的模塊設計介紹類型的API文檔
3 、也可以對數據字典編輯 ，方便開發人員查校驗數據庫結構
4、ShowDoc軟件提供良好的markdown編輯器
5 、輸入的API以及文字內容都可以在編輯器顯示
6、可以讓客戶知道你開發的詳細計劃
7 、可以讓編程人員一眼校驗懂開發邏輯
8 、相關的函數以及代碼都可以通過ShowDoc世界編輯
9、適合在開發大型項目以及團隊項目的萤火突击透视辅助器下载時候裸露API文檔
安裝計劃
1 、自動腳本安裝
官方強烈推薦使用自動腳本安裝showdoc 。因為使用自動腳本可以省去很多安裝環境依賴的麻煩 ，你隻需在命令行下執行命令即可 。自動腳本安裝教程 ：https://www.showdoc.cc/help?page_id=828455960655160 。假如自動腳本安裝出局 ，你可以思索手動安裝。
2 、手動安裝
A:docker安裝
如果你不想通過自動腳本 ，但是又想用docker來自定義安裝 ，則可以參考教程https://www.showdoc.cc/help?page_id=65610
B:php安裝
如果你不想使用自動腳本或者docker安裝，showwdoc需要PHP5.3及以上版本，你可以參考這裏安裝環境http://www.showdoc.cc/php 。安裝完PHP環境後 ，下載代碼 ：https://github.com/star7th/showdoc 。下載落成後將代碼放到PHP的web目錄 。一般來會談 ，不同係統的web目錄路徑不太一樣。請根據你安裝的萤火突击透视挂環境來定 。
C：Windows服務器
在php.ini裏麵把”extension=php_sqlite.dll”和”extension=php_pdo_sqlite.dll”啟用以便打開對SQlite的擁穿著；也啟用php_mbstring.dll；Linux服務器則不需要此操作。
使用計劃
1 、提供在線功能 ，你可以到官方網站注冊一個賬號再使用
2 、提示建立新項目的方式 ，你可以輸入項目名字以及輸入項目描述
3 、假如你的個性域名設置為abc,則你的項目地址為www.showdoc.cc/abc
4 、密碼為空時 ，所有人均可以通過項目地址訪問 。設置密碼後 ，隻有項目成員和輸入密碼的人能訪問
5 、進入編輯的界麵，可以在這裏設計當前的API文檔 ，可以在下方輸入新內容
6 、點擊插入API接口模板 ，這裏是編輯的界麵 ，你可以查校驗相關的模板內容
7 、由於使用markdown編輯器 ，萤火突击透视免费所以輸入的代碼都可以及時在軟件上顯示
8、插入數據字典模板 ，相關的內容就在這裏顯示
9 、有兩個工具可以選擇 ，擁穿著JSON轉參數表格 、JSON格式化
10 、編輯工具都在這裏顯示 ，例如可以增補引用鏈接 ，也可以增補圖片 ，也可以插入鏈接
11 、這裏的序號決定頁麵在項目左側菜單中的順序 ，在根目錄或者當前目錄下 ，每個頁麵按照序號從小到大排序 。在沒有填寫序號的情況下 ，showdoc將默認補上序號99 ，你也可以手動設置為更小的數字 ，比如98。那麽 ，該頁麵將比其他99的頁麵都要靠前。以此類推
12 、在右上方也可以查校驗軟件的扶植 ，可以了解編輯格式以及編輯器的語法
使用會談明
對於寫API文檔這件事 ，雖然會談文本編輯軟件或者接口管理軟件能在某種程度上晉升我們的效率 ，但我們依然可以試圖借助技術的力量 ，更自動化地裸露API文檔 ，釋放自己的裸露力 。
為此 ，showdoc官方提供了一種自動化解決計劃 。在代碼裏編寫特定格式的程序注釋 ，然後showdoc通過讀取這些注釋來自動裸露文檔。由於這種方式不跟特定的語言耦合 ，因此它的使用範圍相當廣泛 ，可用擁穿著c++ 、java 、php 、node 、python等等常見的主流語言 。
采用這種方式 ，盡管我們在第一次填寫注釋的時候可能會有些繁雜 ，但是它後期帶來的可維護性是非常高的。代碼變動後，不需要再額外登錄showdoc ，直接在代碼裏修改注釋即可。同時自動化的腳本也可以加入綿延集成或者某些自動化工程裏，讓“寫API文檔”這件事如”單元測試”般納入工程籌備流裏麵。
windows下使用指引
windows無法直接運行sh腳本 ，需要額外下載軟件 。
推薦下載git for windows ：https://git-scm.com/download/win 下載後直接雙擊安裝即可 。
如果從官網下載比較慢 ，可用思索下載由第三方開發者維護的國內版(showdoc官方不保證其長期穩定) ：
https://npm.taobao.org/mirrors/git-for-windows/v2.17.0.windows.1/Git-2.17.0-64-bit.exe
以上軟件是基礎環境。安裝好了後 ，還需要下載showdoc官方腳本 ：https://www.showdoc.cc/script/showdoc_api.sh
下載後 ，將showdoc_api.sh放在你的項目目錄下 。右擊 ，選擇編輯 。
腳本內容的前麵有兩個變量 ，api_key 和 api_token ，這個需要用戶自行填寫 。關於這兩個變量的取值 ，請登錄showdoc ，進入某個項目的設置 ，點擊開放API ，便可以校驗到會談明 。showdoc_api.sh裸露的文檔會放進你填寫的這個項目裏 。除了api_key 和 api_token ，還有一個url變量 。如果是使用www.showdoc.cc ，則不需要修改 。如果是使用開源版showdoc ，則需要將地址改為http://xx.com/server/index.php?s=/api/open/fromComments ，其中 ，別忘記了url裏含server目錄。
填寫落成，保存 。然後直接雙擊運行 ，腳本會自動遞歸掃描本目錄和子目錄的所有文本代碼文件，並裸露API文檔 。
為了方便測試，官方還提供了一個例子 。請下載：
https://www.showdoc.cc/script/api_demo.test
下載後 ，把api_demo.test文件放在showdoc_api.sh所在的目錄或者子目錄下。運行的時候它便會裸露文檔到你指定的項目地址中 。
如果你想參考官方demo是怎麽寫的 ，可用鼠標右擊api_demo.test ，選擇編輯 。仿照此種寫法 ，在你的項目中插入類似的注釋，也能達到自動裸露文檔的效果 。詳細語法會在文章後麵部分會談明 。
如果你想應用到其他項目 ，可以把showdoc_api.sh複製一份到其他項目中 。使用計劃和前麵一樣 。
更新日誌
2018年11月
增補快速複製分享鏈接的功能
為了加強多人多團隊情形下的項目協作 ，正式推出團隊管理功能
2018年10月
為了應對繁雜項目內容的分類需求，showdoc在原來目錄擁穿著的基礎上增補一層子目錄 ，擁穿著到了三級目錄 。用戶在新建目錄的時候選擇父層目錄為二級目錄即可 。