优化注释

2023-02-08 22:35:27 +08:00 · 2023-02-08 22:35:27 +08:00 · d371cc09b3
commit d371cc09b3
parent 67a7002796
10 changed files with 76 additions and 82 deletions
--- a/authorization.go
+++ b/authorization.go
@ -1,8 +1,8 @@
 /*
- * @FileName:   auth.go
- * @Author:		JJXu
- * @CreateTime:	2022/3/24 上午12:09
- * @Description:
+ *FileName:   auth.go
+ *Author:		JJXu
+ *CreateTime:	2022/3/24 上午12:09
+ *Description:
 */

 package simpleRequest
@ -16,24 +16,20 @@ type Authorization struct {
 	simpleReq *SimpleRequest
 }

-//
 // Basic
-//  @Description: 身份验证，使用bearer 令牌bearer 令牌
-//  @receiver s
-//  @param username
-//  @param password
-//
+// Description: 身份验证，使用bearer 令牌bearer 令牌
+// receiver s
+// param username
+// param password
 func (s *Authorization) Bearer(token string) {
 	s.simpleReq.headers.Set("Authorization", fmt.Sprintf("Bearer %v", token))
 }

-//
 // Basic
-//  @Description: 身份验证的基本验证方案
-//  @receiver s
-//  @param username
-//  @param password
-//
+// Description: 身份验证的基本验证方案
+// receiver s
+// param username
+// param password
 func (s *Authorization) Basic(username, password string) {
 	authStr := fmt.Sprintf("%v:%v", username, password)
 	data := base64.StdEncoding.EncodeToString([]byte(authStr))
--- a/body.go
+++ b/body.go
@ -1,8 +1,8 @@
 /*
- * @FileName:   body.go
- * @Author:		JJXu
- * @CreateTime:	2022/3/2 上午1:23
- * @Description:
+ *FileName:   body.go
+ *Author:		JJXu
+ *CreateTime:	2022/3/2 上午1:23
+ *Description:
 */

 package simpleRequest
--- a/excample/simpleRequest_test.go
+++ b/excample/simpleRequest_test.go
@ -1,8 +1,8 @@
 /*
- * @FileName:   simpleRequest_test.go
- * @Author:		JJXu
- * @CreateTime:	2022/3/3 下午11:34
- * @Description:
+ *FileName:   simpleRequest_test.go
+ *Author:		JJXu
+ *CreateTime:	2022/3/3 下午11:34
+ *Description:
 */

 package excample
--- a/headers.go
+++ b/headers.go
@ -1,8 +1,8 @@
 /*
- * @FileName:   header.go
- * @Author:		JJXu
- * @CreateTime:	2022/3/1 下午9:44
- * @Description:
+ *FileName:   header.go
+ *Author:		JJXu
+ *CreateTime:	2022/3/1 下午9:44
+ *Description:
 */

 package simpleRequest
@ -127,7 +127,6 @@ func (s *HeadersConf) ConentType_textPlain() *HeadersConf {
 	return s
 }

-//
 func (s *HeadersConf) SetConentLength(value string) *HeadersConf {
 	s.simpleReq.headers.Set(hdrContentLengthKey, value)
 	return s
--- a/options.go
+++ b/options.go
@ -1,8 +1,8 @@
 // Package simpleRequest -----------------------------
-// @file      : options.go
-// @author    : JJXu
-// @contact   : wavingBear@163.com
-// @time      : 2022/12/10 01:45:37
+// file      : options.go
+// author    : JJXu
+// contact   : wavingBear@163.com
+// time      : 2022/12/10 01:45:37
 // -------------------------------------------
 package simpleRequest

--- a/param.go
+++ b/param.go
@ -1,8 +1,8 @@
 /*
- * @FileName:   param.go
- * @Author:		JJXu
- * @CreateTime:	2022/3/1 下午9:07
- * @Description:
+ *FileName:   param.go
+ *Author:		JJXu
+ *CreateTime:	2022/3/1 下午9:07
+ *Description:
 */

 package simpleRequest
--- a/parser.go
+++ b/parser.go
@ -1,8 +1,8 @@
 // Package simpleRequest -----------------------------
-// @file      : parser.go
-// @author    : JJXu
-// @contact   : wavingBear@163.com
-// @time      : 2022/12/10 00:48:45
+// file      : parser.go
+// author    : JJXu
+// contact   : wavingBear@163.com
+// time      : 2022/12/10 00:48:45
 // -------------------------------------------
 package simpleRequest

--- a/simpleRequest.go
+++ b/simpleRequest.go
@ -1,8 +1,8 @@
 /*
- * @FileName:   simpleRequest.go
- * @Author:		JJXu
- * @CreateTime:	2022/3/2 上午12:33
- * @Description:
+ *FileName:   simpleRequest.go
+ *Author:		JJXu
+ *CreateTime:	2022/3/2 上午12:33
+ *Description:
 */

 package simpleRequest
@ -260,7 +260,6 @@ func (s *SimpleRequest) TRACE(url string) (body []byte, err error) {
 // ------------------------------------------------------
 //
 //	这里数据
-//
 func (s *SimpleRequest) initBody() {
 	contentTypeData := s.headers.Get(hdrContentTypeKey)
 	switch {
--- a/simpleRequest_test.go
+++ b/simpleRequest_test.go
@ -1,8 +1,8 @@
 // Package simpleRequest -----------------------------
-// @file      : simpleRequest_test.go
-// @author    : JJXu
-// @contact   : wavingBear@163.com
-// @time      : 2022/12/9 20:34:52
+// file      : simpleRequest_test.go
+// author    : JJXu
+// contact   : wavingBear@163.com
+// time      : 2022/12/9 20:34:52
 // -------------------------------------------
 package simpleRequest

--- a/utils.go
+++ b/utils.go
@ -1,8 +1,8 @@
 /*
- * @FileName:   utils.go
- * @Author:		JJXu
- * @CreateTime:	2022/3/29 上午11:16
- * @Description:
+ *FileName:   utils.go
+ *Author:		JJXu
+ *CreateTime:	2022/3/29 上午11:16
+ *Description:
 */

 package simpleRequest