go語言的註釋編碼規範是什麼

註釋編碼規範：1、所有匯出物件都需要註釋說明其用途；非匯出物件根據情況進行註釋。2、如果物件可數且無明確指定數量的情況下，一律使用單數形式和一般進行時描述；否則使用複數形式。3、包、函數、方法和型別的註釋說明都是一個完整的句子。4、句子型別的註釋首字母均需大寫；短語型別的註釋首字母需小寫。5、註釋的單行長度不能超過80個字元。

php入門到就業線上直播課：進入學習
Apipost = Postman + Swagger + Mock + Jmeter 超好用的API偵錯工具：

本教學操作環境：windows7系統、GO 1.18版本、Dell G3電腦。

註釋的意義

註釋可以幫我們很好的完成檔案的工作，寫得好的註釋可以方便我們以後的維護。
/**/ 的塊註釋和 // 的單行註釋兩種註釋風格，在我們的專案中為了風格的統一，全部使用單行註釋，註釋的品質決定了生成的檔案的品質。

註釋規範

所有匯出物件都需要註釋說明其用途；非匯出物件根據情況進行註釋。
如果物件可數且無明確指定數量的情況下，一律使用單數形式和一般進行時描述；否則使用複數形式。
包、函數、方法和型別的註釋說明都是一個完整的句子。
句子型別的註釋首字母均需大寫；短語型別的註釋首字母需小寫。
註釋的單行長度不能超過80個字元。

1、包級別

包級別的註釋就是對包的介紹，只需在同個包的任一原始檔中說明即可有效。【相關推薦：Go視訊教學、】

每個包都應該有一個包註釋，一個位於 package 子句之前行註釋
包註釋應該包含下面基本資訊

// @Title  請填寫檔名稱（需要改）
// @Description  請填寫檔案描述（需要改）
// @Author  請填寫自己的真是姓名（需要改）  ${DATE} ${TIME}
// @Update  請填寫自己的真是姓名（需要改）  ${DATE} ${TIME}
package ${GO_PACKAGE_NAME}
登入後複製

2、結構（介面）註釋

每個自定義的結構體或者介面都應該有註釋說明，該註釋對結構進行簡要介紹，放在結構體定義的前一行，格式為：結構體名，結構體說明。同時結構體內的每個成員變數都要有說明，該說明放在成員變數的後面（注意對齊），範例如下：

// User   使用者物件，定義了使用者的基礎資訊
type User struct{
    Username  string // 使用者名稱
    Email     string // 郵箱
}
登入後複製

3、函數（方法）註釋

每個函數，或者方法（結構體或者介面下的函數稱為方法）都應該有註釋說明
函數的註釋應該包括三個方面

// @title    函數名稱
// @description   函數的詳細描述
// @auth      作者             時間（2019/6/18   10:57 ）
// @param     輸入引數名        引數型別         "解釋"
// @return    返回引數名        引數型別         "解釋"
登入後複製

4、程式碼邏輯註釋

每個程式碼塊都要新增單行註釋
注視使用 TODO 開始詳細如下

// TODO  程式碼塊的執行解釋
if   userAge < 18 {

}
登入後複製

其它說明

當某個部分等待完成時，可用 TODO: 開頭的註釋來提醒維護人員。
當某個部分存在已知問題進行需要修復或改進時，可用 FIXME: 開頭的註釋來提醒維護人員。
當需要特別說明某個問題時，可用 NOTE: 開頭的註釋：

  // NOTE: os.Chmod and os.Chtimes don't recognize symbolic link,
  // which will lead "no such file or directory" error.
  return os.Symlink(target, dest)
登入後複製

更多程式設計相關知識，請存取：！！

以上就是go語言的註釋編碼規範是什麼的詳細內容，更多請關注TW511.COM其它相關文章！