Skip to content

Commit ba7f73c

Browse files
nk-akunnk-akun
committed
refactor: add comments to variables
1 parent 3306ce1 commit ba7f73c

File tree

4 files changed

+80
-78
lines changed

4 files changed

+80
-78
lines changed

‎model/constant.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ const (
99
CTXAPIResponseMessage = "api_response_message"
1010
CTXAPIResponseSuccess = "api_response_success"
1111

12-
TokenExpireDays = 2
13-
MAXCursorTime = 2559090472000
12+
TokenExpireDays = 2 // 默认缓存登录状态时间
13+
MAXCursorTime = 2559090472000 // 默认游标时间
1414
)

‎model/model.go‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -11,23 +11,23 @@ type Model struct {
1111
// User stores user infomation
1212
type User struct {
1313
Model
14-
Username string `gorm:"column:username;type:varchar(20);unique;not null" json:"username"`
15-
Nickname string `gorm:"column:nickname;type:varchar(30)" json:"nickname"`
16-
Password string `gorm:"column:password;type:varchar(100);not null" json:"password"`
17-
AvatarURL string `gorm:"column:avatar_url;type:varchar(200)" json:"avatar_url"`
18-
Gender string `gorm:"column:gender;type:tinyint;default:2" json:"gender"`
19-
Email string `gorm:"column:email;type:varchar(50)" json:"email"`
20-
EmailVerified bool `gorm:"column:email_verified;type:tinyint;default 0" json:"email_verified"`
21-
Description string `gorm:"column:description;type:varchar(200)" json:"description"`
22-
AttentionCount int `gorm:"column:attention_count;type:int;default:0" json:"attention_count"`
23-
FavouriteArticleCount int `gorm:"column:favourite_article_count;type:int;default:0" json:"favourite_article_count"`
24-
FansCount int `gorm:"column:fans_count;type:int;default:0" json:"fans_count"`
25-
PostCount int `gorm:"column:post_count;type:int;default:0" json:"post_count"`
26-
CommentCount int `gorm:"column:comment_count;type:int;default:0" json:"comment_count"`
27-
Type int `gorm:"column:type;type:int;default:0" json:"type"`
28-
City string `gorm:"column:city;type:varchar(50)" json:"city"`
29-
Province string `gorm:"column:province;type:varchar(50)" json:"province"`
30-
Country string `gorm:"column:country;type:varchar(50)" json:"country"`
14+
Username string `gorm:"column:username;type:varchar(20);unique;not null" json:"username"` // 用户名
15+
Nickname string `gorm:"column:nickname;type:varchar(30)" json:"nickname"` // 昵称
16+
Password string `gorm:"column:password;type:varchar(100);not null" json:"password"` // 密码
17+
AvatarURL string `gorm:"column:avatar_url;type:varchar(200)" json:"avatar_url"` // 头像
18+
Gender string `gorm:"column:gender;type:tinyint;default:2" json:"gender"` // 性别
19+
Email string `gorm:"column:email;type:varchar(50)" json:"email"` // 邮箱
20+
EmailVerified bool `gorm:"column:email_verified;type:tinyint;default 0" json:"email_verified"` // 邮箱是否已验证
21+
Description string `gorm:"column:description;type:varchar(200)" json:"description"` // 个人描述
22+
AttentionCount int `gorm:"column:attention_count;type:int;default:0" json:"attention_count"` // 关注数
23+
FavouriteArticleCount int `gorm:"column:favourite_article_count;type:int;default:0" json:"favourite_article_count"` // 收藏的文章数
24+
FansCount int `gorm:"column:fans_count;type:int;default:0" json:"fans_count"` // 粉丝数
25+
PostCount int `gorm:"column:post_count;type:int;default:0" json:"post_count"` // 发表数
26+
CommentCount int `gorm:"column:comment_count;type:int;default:0" json:"comment_count"` // 评论数
27+
Type int `gorm:"column:type;type:int;default:0" json:"type"` // 用户类型
28+
City string `gorm:"column:city;type:varchar(50)" json:"city"` // 城市
29+
Province string `gorm:"column:province;type:varchar(50)" json:"province"` // 省份
30+
Country string `gorm:"column:country;type:varchar(50)" json:"country"` // 国家
3131
CreateTime int64 `gorm:"column:create_time;default:null" json:"create_time"`
3232
UpdateTime int64 `gorm:"column:update_time;default:null" json:"update_time"`
3333
DeleteTime int64 `gorm:"column:delete_time;default:null" json:"delete_time"`
@@ -37,22 +37,22 @@ type User struct {
3737
type UserToken struct {
3838
Model
3939
UserID int64 `gorm:"column:user_id;type:int" json:"user_id"`
40-
Token string `gorm:"type:varchar(40);unique;not null" json:"token"`
41-
ExpiredAt int64 `gorm:"column:expired_at;type:int" json:"expired_at"`
40+
Token string `gorm:"type:varchar(40);unique;not null" json:"token"` //token
41+
ExpiredAt int64 `gorm:"column:expired_at;type:int" json:"expired_at"` //有效期至
4242
Status bool `gorm:"column:status;type:tinyint;default 0" json:"status"` // 0有效 1失效
4343
CreateTime int64 `gorm:"column:create_time;default:null" json:"create_time"`
4444
}
4545

4646
// Article stores article infomation
4747
type Article struct {
4848
Model
49-
UserID int64 `gorm:"column:user_id;type:int" json:"user_id"`
50-
Title string `gorm:"column:title;type:varchar(50);not null" json:"title"`
51-
Status int `gorm:"column:status;type:tinyint;not null;default:0" json:"status"`
52-
Content string `gorm:"column:content;type:text" json:"content"`
53-
ViewCount int `gorm:"column:view_count;type:int;default:0" json:"view_count"`
54-
CommentCount int `gorm:"column:comment_count;type:int;default:0" json:"comment_count"`
55-
LikeCount int `gorm:"column:like_count;type:int;default:0" json:"like_count"`
49+
UserID int64 `gorm:"column:user_id;type:int" json:"user_id"` //作者ID
50+
Title string `gorm:"column:title;type:varchar(50);not null" json:"title"` //标题
51+
Status int `gorm:"column:status;type:tinyint;not null;default:0" json:"status"` //文章状态
52+
Content string `gorm:"column:content;type:text" json:"content"` //内容
53+
ViewCount int `gorm:"column:view_count;type:int;default:0" json:"view_count"` //浏览数
54+
CommentCount int `gorm:"column:comment_count;type:int;default:0" json:"comment_count"` //评论数
55+
LikeCount int `gorm:"column:like_count;type:int;default:0" json:"like_count"` //点赞数
5656
CreateTime int64 `gorm:"column:create_time;default:null" json:"create_time"`
5757
UpdateTime int64 `gorm:"column:update_time;default:null" json:"update_time"`
5858
DeleteTime int64 `gorm:"column:delete_time;default:null" json:"delete_time"`
@@ -61,12 +61,12 @@ type Article struct {
6161
// Comment stores users' comments
6262
type Comment struct {
6363
Model
64-
UserID int64 `gorm:"column:user_id;type:int" json:"user_id"`
65-
ArticleID int64 `gorm:"column:article_id;type:int" json:"article_id"`
64+
UserID int64 `gorm:"column:user_id;type:int" json:"user_id"` //作者ID
65+
ArticleID int64 `gorm:"column:article_id;type:int" json:"article_id"` //所属的文章ID
6666
Content string `gorm:"column:content;type:text" json:"content"`
67-
ParentID int64 `gorm:"column:parent_id;type:int" json:"parent_id"`
68-
Status int `gorm:"column:status;type:tinyint;not null;default:0" json:"status"`
69-
LikeCount int `gorm:"column:like_count;type:int;default:0" json:"like_count"`
67+
ParentID int64 `gorm:"column:parent_id;type:int" json:"parent_id"` //父评论ID（引用的评论）
68+
Status int `gorm:"column:status;type:tinyint;not null;default:0" json:"status"` //评论状态
69+
LikeCount int `gorm:"column:like_count;type:int;default:0" json:"like_count"` //点赞数
7070
CreateTime int64 `gorm:"column:create_time;default:null" json:"create_time"`
7171
UpdateTime int64 `gorm:"column:update_time;default:null" json:"update_time"`
7272
DeleteTime int64 `gorm:"column:delete_time;default:null" json:"delete_time"`
@@ -77,6 +77,6 @@ type UserLikeArticle struct {
7777
Model
7878
UserID int64 `gorm:"column:user_id;type:int" json:"user_id"`
7979
ArticleID int64 `gorm:"column:article_id;type:int" json:"article_id"`
80-
Status int `gorm:"column:status;type:tinyint;not null;default:0" json:"status"` //是否点赞
80+
Status int `gorm:"column:status;type:tinyint;not null;default:0" json:"status"` //是否点赞 1已点赞，0未点赞
8181
UpdateTime int64 `gorm:"column:update_time;default:null" json:"update_time"`
8282
}

‎model/response.go‎

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@ package model
22

33
// APIResponse ...
44
type APIResponse struct {
5-
Code int `json:"code"`
6-
Value interface{} `json:"value"`
7-
Success bool `json:"success"`
8-
Message string `json:"message"`
5+
Code int `json:"code"` // 返回值code
6+
Value interface{} `json:"value"` // 返回值value
7+
Success bool `json:"success"` // 是否执行成功
8+
Message string `json:"message"` // 附加信息
99
}
1010

1111
// SysConfigResponse ...
@@ -19,64 +19,64 @@ type SysConfigResponse struct {
1919

2020
// ActionLink ...
2121
type ActionLink struct {
22-
Title string `json:"title"`
23-
URL string `json:"url"`
22+
Title string `json:"title"` // 导航标题
23+
URL string `json:"url"` // 导航链接
2424
}
2525

2626
// Article
2727

2828
// ArticleListResponse ...
2929
type ArticleListResponse struct {
30-
TotalNum int `json:"total_num"`
31-
Cursor int64 `json:"cursor"`
32-
ArticleList []*ArticleBriefInfo `json:"article_list"`
30+
TotalNum int `json:"total_num"` // 文章总数
31+
Cursor int64 `json:"cursor"` // 游标
32+
ArticleList []*ArticleBriefInfo `json:"article_list"` // 文章简要信息List
3333
}
3434

3535
// ArticleBriefInfo ...
3636
type ArticleBriefInfo struct {
37-
ArticleID int64 `json:"article_id"`
38-
Title string `json:"title"`
39-
Summary string `json:"summary"`
40-
User *UserBriefInfo `json:"user"`
41-
LikeCount int `json:"like_count"`
42-
CommentCount int `json:"comment_count"`
43-
ViewCount int `json:"view_count"`
44-
Liked bool `json:"liked"`
37+
ArticleID int64 `json:"article_id"` // 文章ID
38+
Title string `json:"title"` // 文章标题
39+
Summary string `json:"summary"` // 简要信息
40+
User *UserBriefInfo `json:"user"` // 作者的简要信息
41+
LikeCount int `json:"like_count"` // 点赞数量
42+
CommentCount int `json:"comment_count"` // 评论数
43+
ViewCount int `json:"view_count"` // 浏览数
44+
Liked bool `json:"liked"` // 当前登录用户是否已点赞(如未登录为false)
4545
CreateTime int64 `json:"create_time"`
4646
}
4747

4848
// ArticleResponse ...
4949
type ArticleResponse struct {
50-
ArticleID int64 `json:"article_id"`
51-
Title string `json:"title"`
52-
User *UserBriefInfo `json:"user"`
53-
Content string `json:"content"`
54-
Liked bool `json:"liked"`
55-
CommentCount int `json:"commnet_count"`
56-
LikeCount int `json:"like_count"`
50+
ArticleID int64 `json:"article_id"` // 文章ID
51+
Title string `json:"title"` // 文章标题
52+
User *UserBriefInfo `json:"user"` // 作者的简要信息
53+
Content string `json:"content"` // 文章内容
54+
Liked bool `json:"liked"` // 当前登录用户是否已点赞(如未登录为false)
55+
CommentCount int `json:"commnet_count"` // 评论数
56+
LikeCount int `json:"like_count"` // 点赞数
5757
CreateTime int64 `json:"create_time"`
5858
}
5959

6060
// Comment
6161

6262
// CommentListResponse ...
6363
type CommentListResponse struct {
64-
ArticleID int64 `json:"article_id"`
65-
TotalNum int `json:"total_num"`
66-
Cursor int64 `json:"cursor"`
67-
CommentList []*CommentInfo `json:"comment_list"`
64+
ArticleID int64 `json:"article_id"` // 所属的文章ID
65+
TotalNum int `json:"total_num"` // 评论总数
66+
Cursor int64 `json:"cursor"` // 游标
67+
CommentList []*CommentInfo `json:"comment_list"` // 评论List
6868
}
6969

7070
// CommentInfo ...
7171
type CommentInfo struct {
72-
CommentID int64 `json:"comment_id"`
73-
AuthorNickName string `json:"user_nickname"`
74-
AuthorUserName string `json:"user_username"`
75-
AuthorID int64 `json:"user_id"`
76-
AvatarURL string `json:"avatar_url"`
77-
Content string `json:"content"`
78-
ParentComment *CommentInfo `json:"parent_comment"`
79-
LikeCount int `json:"like_count"`
72+
CommentID int64 `json:"comment_id"` // 评论ID
73+
AuthorNickName string `json:"user_nickname"` // 作者的昵称
74+
AuthorUserName string `json:"user_username"` // 作者的用户名
75+
AuthorID int64 `json:"user_id"` // 作者ID
76+
AvatarURL string `json:"avatar_url"` // 作者的头像
77+
Content string `json:"content"` // 评论内容
78+
ParentComment *CommentInfo `json:"parent_comment"` // 父评论信息
79+
LikeCount int `json:"like_count"` // 点赞数
8080
CreateTime int64 `json:"create_time"`
8181
}
8282

@@ -98,7 +98,7 @@ func (r *ResponseValue) Set(name string, data interface{}) *ResponseValue {
9898
return r
9999
}
100100

101-
// UserBriefInfo ...
101+
// UserBriefInfo is user's brief information
102102
type UserBriefInfo struct {
103103
ID int64 `json:"id"`
104104
Username string `json:"username"`

‎site/layouts/error.vue‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,20 @@
66
<img src="~/assets/images/logo.png" style="max-width: 100px;" />
77
</div>
88
<div class="description">
9-
<span v-if="error.statusCode === 404">{{
9+
<span v-if="error.statusCode === 404">
10+
{{
1011
error.message ? error.message : '页面没找到'
11-
}}</span>
12-
<span v-if="error.statusCode === 403">{{
12+
}}
13+
</span>
14+
<span v-if="error.statusCode === 403">
15+
{{
1316
error.message ? error.message : 'forbidden'
14-
}}</span>
17+
}}
18+
</span>
1519
<span v-else>{{ error.statusCode }} 页面异常</span>
1620
</div>
1721
<div class="report">
18-
<a href="https://mlog.club/topic/create" target="_blank"
19-
>点击这里反馈该问题>></a
20-
>
22+
<a href="https://github.com/nk-akun/NeighborBBS/issues" target="_blank">点击这里反馈该问题>></a>
2123
</div>
2224
</div>
2325
</div>

0 commit comments

Comments
 (0)