人生苦短,我用Python。
計算機編程語言
編寫帶註釋的單元測試:doctest
單元測試是代碼開發中必不可少的壹部分,對於Bug定位和代碼質量非常重要。
例如:
這是壹個求n的階乘函數的例子,通過>:& gt& gt符號開始單元測試,然後輸入預期的結果。只需復制粘貼調試結果,超級簡單,輕松實現TDD。
編寫帶註釋的API文檔:apidoc
機器學習模型完成後,我們在為外部服務提供接口以貢獻我們的計算能力時,需要使用完整的API文檔。只有調用API,才能為我們的模型持續提供驗證數據,這對提高模型效果有相當大的意義。
使用apidoc可以解決這些API文檔中的很多常見問題,相當於通過模板提高了我們的界面設計能力。
l例如:
這是壹種API接口的定義方法,核心部分是
途徑
獲取/發布方法
名稱/分組
參數和呼叫示例
我們可以直接舉個例子來學習如何使用apidoc,先下載示例源代碼。
git克隆/apidoc/apidoc
cd apidoc
然後安裝apidoc組件。
sudo npm安裝apidoc -g
直接用官方代碼做個例子,隨便逛逛。
apidoc -i示例/-o輸出/-t模板/
打開output/index.html
Apidoc的官方文檔簡單明了,我就不太強調語法了。
Apidoc提供了接口調試功能,在實際使用中需要註意:
我們需要壹個web服務器來使用這個接口的調試功能。
註意跨域問題。
編寫帶有註釋的命令行界面:docopt
例如:
在命令行上,我們可以成功地調用。
fiannceR.py tcp 0.0.0.03838
Arguments將發出壹個dictionary對象,以Key-Value的形式捕獲命令行中的輸入值。
最後
如果真的要從數據到模型和界面,那麽壹排評論的美好是不可想象的。
歡迎大家留言討論,也可以加我群給出更多應用案例分享。