注釋編碼規范:1、所有導出對象都需要注釋說明其用途;非導出對象根據情況進行注釋。2、如果對象可數且無明確指定數量的情況下ef5改模板tt文件對實體添加注釋,一律使用單數形式和一般進行時描述;否則使用復數形式。3、包、函數、方法和類型的注釋說明都是一個完整的句子。4、句子類型的注釋首字母均需大寫;短語類型的注釋首字母需小寫。5、注釋的單行長度不能超過80個字符。
本教程操作環境:系統、GO 1.18版本、Dell G3電腦。
注釋的意義注釋規范
1、包級別
包級別的注釋就是對包的介紹ef5改模板tt文件對實體添加注釋,只需在同個包的任一源文件中說明即可有效。【相關推薦:Go視頻教程、編程教學】
// @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 代碼塊的執行解釋 if userAge < 18 { }
登錄后復制
其它說明
// 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)
登錄后復制