docs:调整部分代码注释以及代码格式

server/api/v1/system/auto_code_plugin.go

@@ -70,7 +70,7 @@ func (a *AutoCodePluginApi) Packaged(c *gin.Context) {
 	response.OkWithMessage(fmt.Sprintf("打包成功,文件路径为:%s", zipPath), c)
 }
 
-// Packaged
+// InitMenu
 // @Tags      AutoCodePlugin
 // @Summary   打包插件
 // @Security  ApiKeyAuth
@@ -94,7 +94,7 @@ func (a *AutoCodePluginApi) InitMenu(c *gin.Context) {
 	response.OkWithMessage("文件变更成功", c)
 }
 
-// Packaged
+// InitAPI
 // @Tags      AutoCodePlugin
 // @Summary   打包插件
 // @Security  ApiKeyAuth

server/api/v1/system/auto_code_template.go

@@ -82,7 +82,7 @@ func (a *AutoCodeTemplateApi) Create(c *gin.Context) {
 	}
 }
 
-// Create
+// AddFunc
 // @Tags      AddFunc
 // @Summary   增加方法
 // @Security  ApiKeyAuth

server/initialize/gorm_mssql.go

@@ -1,3 +1,5 @@
+package initialize
+
 /*
  * @Author: 逆光飞翔 191180776@qq.com
  * @Date: 2022-12-08 17:25:49
@@ -6,7 +8,6 @@
  * @FilePath: \server\initialize\gorm_mssql.go
  * @Description: 这是默认设置,请设置`customMade`, 打开koroFileHeader查看配置 进行设置: https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE
  */
-package initialize
 
 import (
 	"github.com/flipped-aurora/gin-vue-admin/server/config"
@@ -44,8 +45,8 @@ func GormMssqlByConfig(m config.Mssql) *gorm.DB {
 		return nil
 	}
 	mssqlConfig := sqlserver.Config{
-		DSN:                       m.Dsn(), // DSN data source name
-		DefaultStringSize:         191,     // string 类型字段的默认长度
+		DSN:               m.Dsn(), // DSN data source name
+		DefaultStringSize: 191,     // string 类型字段的默认长度
 	}
 	if db, err := gorm.Open(sqlserver.New(mssqlConfig), internal.Gorm.Config(m.Prefix, m.Singular)); err != nil {
 		panic(err)

server/service/example/exa_breakpoint_continue.go

@@ -58,7 +58,7 @@ func (e *FileUploadAndDownloadService) CreateFileChunk(id uint, fileChunkPath st
 func (e *FileUploadAndDownloadService) DeleteFileChunk(fileMd5 string, filePath string) error {
 	var chunks []example.ExaFileChunk
 	var file example.ExaFile
-	err := global.GVA_DB.Where("file_md5 = ? ", fileMd5).First(&file).
+	err := global.GVA_DB.Where("file_md5 = ?", fileMd5).First(&file).
 		Updates(map[string]interface{}{
 			"IsFinish":  true,
 			"file_path": filePath,

server/utils/ast/ast.go

@@ -158,7 +158,7 @@ func CreateApiStructAst(apis []system.SysApi) *[]ast.Expr {
 	return &apiElts
 }
 
-// 检查是否存在Import
+// CheckImport 检查是否存在Import
 func CheckImport(file *ast.File, importPath string) bool {
 	for _, imp := range file.Imports {
 		// Remove quotes around the import path

server/utils/ast/ast_gorm.go

@@ -10,7 +10,7 @@ import (
 	"os"
 )
 
-// 自动为 gorm.go 注册一个自动迁移
+// AddRegisterTablesAst 自动为 gorm.go 注册一个自动迁移
 func AddRegisterTablesAst(path, funcName, pk, varName, dbName, model string) {
 	modelPk := fmt.Sprintf("github.com/flipped-aurora/gin-vue-admin/server/model/%s", pk)
 	src, err := os.ReadFile(path)
@@ -147,7 +147,7 @@ func addAutoMigrate(astBody *ast.BlockStmt, dbname string, pk string, model stri
 	}
 }
 
-// 为automigrate增加实参
+// NeedAppendModel 为automigrate增加实参
 func NeedAppendModel(callNode ast.Node, pk string, model string) bool {
 	flag := true
 	ast.Inspect(callNode, func(node ast.Node) bool {

server/utils/fmt_plus.go

@@ -67,7 +67,7 @@ func MaheHump(s string) string {
 	return strings.Join(words, "")
 }
 
-// 随机字符串
+// RandomString 随机字符串
 func RandomString(n int) string {
 	var letters = []rune("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789")
 	b := make([]rune, n)

server/utils/jwt.go

@@ -43,7 +43,7 @@ func (j *JWT) CreateClaims(baseClaims request.BaseClaims) request.CustomClaims {
 	return claims
 }
 
-// 创建一个token
+// CreateToken 创建一个token
 func (j *JWT) CreateToken(claims request.CustomClaims) (string, error) {
 	token := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)
 	return token.SignedString(j.SigningKey)
@@ -57,7 +57,7 @@ func (j *JWT) CreateTokenByOldToken(oldToken string, claims request.CustomClaims
 	return v.(string), err
 }
 
-// 解析 token
+// ParseToken 解析 token
 func (j *JWT) ParseToken(tokenString string) (*request.CustomClaims, error) {
 	token, err := jwt.ParseWithClaims(tokenString, &request.CustomClaims{}, func(token *jwt.Token) (i interface{}, e error) {
 		return j.SigningKey, nil

server/utils/timer/timed_task.go

@@ -72,7 +72,7 @@ func (t *timer) AddTaskByFunc(cronName string, spec string, fun func(), taskName
 	return id, err
 }
 
-// AddTaskByFuncWithSeconds 通过函数的方法使用WithSeconds添加任务
+// AddTaskByFuncWithSecond 通过函数的方法使用WithSeconds添加任务
 func (t *timer) AddTaskByFuncWithSecond(cronName string, spec string, fun func(), taskName string, option ...cron.Option) (cron.EntryID, error) {
 	t.Lock()
 	defer t.Unlock()
@@ -186,7 +186,7 @@ func (t *timer) StopCron(cronName string) {
 	}
 }
 
-// Remove 从cronName 删除指定任务
+// RemoveTask 从cronName 删除指定任务
 func (t *timer) RemoveTask(cronName string, id int) {
 	t.Lock()
 	defer t.Unlock()