在項目集成階段中,接口文檔是不可避免的,以往的我使用word編輯器編寫接口文檔,雖然word使用不是很熟練,但是只要在網上下載模板或者自己花時間搞定一個文檔格式
基本能一勞永逸。但是還是會有很多問題存在,比如,docx在git上是不能記錄版本的,如果你想使用docx作為借口文檔,並且還有接口文檔版本化這么一個過程,推薦使用markdown,目前我在使用一款markdown工具,叫Typora。
地址:http://www.typora.io/
這款markdown工具首先是小巧,但是功能缺很強大,支持markdown的標准語法,同時這款軟件還支持動態預覽功能,一鍵預覽,一鍵源碼,感覺上很爽,這款軟件可以對
圖片、代碼、有序/無序列表、代碼塊、數學公式和目錄都支持,你想要的基本都有。
這款軟件還可以自定義CSS,感覺默認的樣式不美觀,動手自己修改,有道是,別人的不如自己的,看不慣你就換。
讓我最心儀的功能還是它可以轉換成PDF,這樣更方便我提供給客戶,並且能做版本控制和記錄。
不太爽的是mac和windows下,導出功能丟了好多。
有需求的人要markdown,可以嘗試一下Typora。
markdown的基本語法:http://www.appinn.com/markdown/