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

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

本教學操作環境：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語言的註釋編碼規範是什麼的詳細內容。更多資訊請關注PHP中文網其他相關文章！