🎋 竹子日誌

JSDoc

雖然jsdoc已經很久了,但不知道的人意外還是不少。我一直以來都很推使用 jsdoc ,也確實推坑不少人使用,近日感覺使用的人真的越來越多。

過去在提議使用 jsdoc 時,很多人都說,為什麼不乾脆使用 TypeScript 就好?當然是因為沒辦法任意導入自己想要的技術才需要 jsdoc 啊~如果對於一個團隊你可以任意使用技術,這是一件多麼可怕的事。所以拜託不要再說什麼不需要用 TypeScript 就不需要 JSDoc 這種話,這一點幫助都沒有。

與其說,jsdoc 是一個閹割版的型別檢查器,我覺得它更多是輔助的價值。除了可以在 JavaScript 環境有很好的型別優化,更能夠提供許多編輯器的輔助提示。因為 vscode 解析時還能針對 markdown 進行解析,所以其實能玩出蠻多的花樣,讓使用你code 的人有很好的操作體驗。

自從體驗到 TypeScript 的編輯器提示優化後,真心有種回不去的感覺。但其實並不是每份工作都可以開心使用 TypeScript ,所以有一段時間我是使用 jsdoc 去進行型別檢查,也大幅提高程式碼的可閱讀的體驗。能依賴編輯器提供輔助提示,享受如套件生態系提供的享受,這種感覺讓開發更舒服。

你也有用過 JSDoc嗎?可以跟我分享你的經驗喔!

留言