Golang 高效编程 godoc 包注释 注释文件标注风格
生活随笔
收集整理的這篇文章主要介紹了
Golang 高效编程 godoc 包注释 注释文件标注风格
小編覺得挺不錯的,現在分享給大家,幫大家做個參考.
1. 源代碼中每一個包都需要具有 包注釋。
2. 包注釋用一個代碼塊表示。
3. 包注釋寫在包聲明的上面。一個包只需要一個包聲明,因此:一個包只需要一個包注釋。
4. 使用 godoc 可以生成注釋文件。
5. 在 Golang 源程序中,每個可導出(首字母大寫)的名稱(接口、函數)都應該有文檔注釋。
6. 注釋應該以 名稱 開頭,可以是接口/函數的名稱,也可以是包名稱。
7. 獲取自定義注釋說明的方法:命令行輸入:godoc 名稱
這里的名稱可以是接口/函數的名稱,也可以是包名稱。
總結
以上是生活随笔為你收集整理的Golang 高效编程 godoc 包注释 注释文件标注风格的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 八、kubernetes Pod控制器
- 下一篇: 2022“杭电杯”中国大学生算法设计超级