iT邦幫忙

2023 iThome 鐵人賽

DAY 7
0
自我挑戰組

和地鼠做30天好朋友系列 第 7

地鼠愛文件

  • 分享至 

  • xImage
  •  

我來填一下第一天說到的坑:go doc這個指令...

作為開發者過來人,我知道我們都不喜歡寫~文件

於是...一些很懶得工程師們說,要有phpdoc、就有了phpdoc..。甚至最後發展出Swagger+符合OPEN API規格的 JSON 文件等等等...

地鼠也聽到了...所以便有了go doc這個指令

來弄個ChatGPT的官腔功能:go doc是 Go 語言的官方文檔工具,它使開發人員能夠輕鬆獲取有關庫、函數、類型和方法的信息。這個工具簡化了閱讀程式碼和理解代碼的過程。

讓我們來玩一下吧 😝

go doc {package}

這將顯示指定 package 底下的所有函數、常數和相關註解等內容。如果你想查看特定函數的信息,只需提供函數名,例如:

go doc fmt.Println

他的魔法在於,你可以寫一點點註解、它就自動幫你分析你寫的func參數,不用搞那落落長的JSON或者背誦那些註釋形式的語法...超方便der ~

最後繼續水一些字數,他的優勢如下

  • 快速查詢:你可以迅速獲取 Go 標準Package和自定義的文檔,不用離開黑畫面。
  • 詳細信息:因為他也包括函數、方法和類型的描述、參數、返回值,我認為這很好去讓我們了解怎麼使用...只是你要耐心點看文件就是了 😅

上一篇
結合其他強大的地鼠,我要成為地鼠之王
下一篇
地鼠,幫圖片加亮一點吧
系列文
和地鼠做30天好朋友12
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言