enhancement: remove backticks from struct field's comment (#442)

swaggo · Jul 10, 2019 · 288d21c · 288d21c
1 parent be6d0b2
commit 288d21c
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 3 deletions.
diff --git a/parser.go b/parser.go
@@ -843,10 +843,10 @@ func (parser *Parser) parseStruct(pkgName string, field *ast.Field) (map[string]
 	}
 	var desc string
 	if field.Doc != nil {
-		desc = strings.TrimSpace(field.Doc.Text())
+		desc = strings.TrimSpace(strings.Replace(field.Doc.Text(), "`", "", -1))
 	}
 	if desc == "" && field.Comment != nil {
-		desc = strings.TrimSpace(field.Comment.Text())
+		desc = strings.TrimSpace(strings.Replace(field.Comment.Text(), "`", "", -1))
 	}
 	// TODO: find package of schemaType and/or arrayType
 

diff --git a/parser_test.go b/parser_test.go
@@ -1950,6 +1950,14 @@ func TestParseStructComment(t *testing.T) {
                 "error": {
                     "description": "Error an Api error",
                     "type": "string"
+                },
+                "errorCtx": {
+                    "description": "Error context tick comment",
+                    "type": "string"
+                },
+                "errorNo": {
+                    "description": "Error number tick comment",
+                    "type": "integer"
                 }
             }
         },

diff --git a/testdata/struct_comment/web/handler.go b/testdata/struct_comment/web/handler.go
@@ -17,6 +17,9 @@ type Post struct {
 
 type APIError struct {
 	// Error an Api error
-	Error     string    // Error this is Line comment
+	Error string // Error this is Line comment
+	// Error `number` tick comment
+	ErrorNo   int64
+	ErrorCtx  string    // Error `context` tick comment
 	CreatedAt time.Time // Error time
 }