之前編寫**都是比較隨意的，也沒有什麼注釋要佔**的1/3以上的概念，想寫就寫，不想寫就不寫，即使是寫也是簡單幾個字，一筆帶過。可能從心底就覺得，誰又會看我寫的**呢，渣渣~
一旦乙個人的學習鬥志被激發出來，那就是所謂的興趣吧！我們一起來學習吧~
我們都知道**的注釋分為三種，筆者之前的編碼生涯中也只是用過單行注釋跟多行注釋而已，以後就不同了，開啟文件注釋模式，生成屬於自己專案的api文件，向終極boss進軍。對於開發，每個人的習慣不同，編碼方式也不盡相同。所以要時刻做好接受別人檢閱我們**的準備，首要任務就是做好注釋。
我們現在用的最多的工具應該就是myeclipse了，注意進入的目錄，以及所建類所在路徑即可。
對於editplus來說，是一樣的道理。
效果圖如下：
apiDoc 生成api文件
安裝node.js 安裝apidoc npm install apidoc g在你的專案根目錄下新建apidoc.json檔案，該檔案描述了專案對外提供介面的概要資訊如名稱 版本 描述 文件開啟時瀏覽器顯示標題和介面預設訪問位址。apidoc.json apidefine rknotfoundexc...
API文件自動生成
1 安裝coreapi pip install coreapi 2 在路由配置文件鏈結 from rest framework.documentation import include docs urls urlpatterns path docs include docs urls title 站...
DocFX生成API文件
弄了個開源專案 unity shader graph中英文對照api 採用docfx對markdown文件進行生成 docfx 簡單使用方法 自動生成目錄的工具 使用docfx 建立屬於你的github 文件頁面 當然如果你希望本地看 windows使用者需要自行配置iss，然後新增 選擇 site...